Ledger Transaction

The Ledger API exposes details of company pay items including all the allowances, statutory deductions, non-statutory deductions, and net salaries.

If you want your results grouped, you can include group_by as a query parameter. The group_by parameter can either be one of the following: employee, cost_center, branch. Default is employee.

If you run multiple payroll batches, then batch should be supplied to get the exact data. It defaults to 1.

Query Params
string
required
Defaults to June 2024

This is the payroll cycle label e.g November 2023

string
required

This is the company name on HRMS

string

The group_by params can either be one of the following: employee | cost_center | branch

string

Here, if you wish to get a particular cost_center OR branch, you can pass q along with the group_by parameter

integer
Defaults to 1

This is needed when payroll run frequency is more than 1

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json