Payslips & compensation
Get Hris Payslips For Org
Lists org payslips with search, period and department filters, sorting, pagination and a monthly dashboard summary.
Required scope: compensation:read
curl --request POST \
--url 'https://api.toku.com/hris/get-hris-payslips-for-org' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"summaryOnly": true,
"search": "string",
"periodKey": "string",
"department": "string",
"sortBy": "employee",
"sortDirection": "asc",
"limit": 10,
"offset": 0
}'{
"totalCount": 0,
"hasDigitalAssetPayslips": true,
"payslips": [
{
"hrisPayslipID": "string",
"roleInOrgID": "string",
"payslipDate": "string",
"payPeriodLabel": "string",
"grossAmount": "string",
"employeeWithholdingAmount": "string",
"deductionsAmount": "string",
"netAmount": "string",
"digitalAssetGross": "string",
"digitalAssetNet": "string",
"tokenWithholdingAmount": "string",
"payslipKind": "string",
"tokenCurrency": {
"currencyID": "string",
"currencyCode": "string",
"name": "string"
},
"createdAt": "string",
"employee": {
"roleInOrgID": "string",
"fullName": "string",
"email": "string",
"department": "string"
},
"currency": {
"currencyID": "string",
"currencyCode": "string",
"name": "string"
},
"file": {
"fileID": "string",
"fileName": "string",
"mimeType": "string",
"fileSizeInBytes": 0
}
}
],
"dashboardSummary": {
"monthLabel": "string",
"totalsByCurrency": [
{
"currencyID": "string",
"currencyCode": "string",
"currencyName": "string",
"totalGrossAmount": "string",
"totalNetAmount": "string"
}
],
"employeesPaidCount": 0,
"pendingCount": 0
}
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Body
application/json
summaryOnlybooleansearchstringNOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it
Allowed: at most 100 characters
periodKeystringAllowed: matches ^\d{4}-(0[1-9]|1[0-2])$
departmentstringNOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it Filters to one department. Blank is the same as omitted.
sortBystringAvailable options: employee, payslipDate, grossAmount, netAmount, digitalAssetGross, digitalAssetNet
sortDirectionstringAvailable options: asc, desc
limitintegerAllowed: 1 to 20000
Default: 10
offsetintegerAllowed: at least 0
Default: 0
Response
200Successful response
totalCountnumberrequiredhasDigitalAssetPayslipsbooleanrequiredpayslipsobject[]requiredShow child attributes
hrisPayslipIDstringrequiredroleInOrgIDstringrequiredpayslipDatestringrequiredpayPeriodLabelstringrequiredgrossAmountstringrequiredemployeeWithholdingAmountstringrequireddeductionsAmountstringrequirednetAmountstringrequireddigitalAssetGrossstring | nullrequireddigitalAssetNetstring | nullrequiredtokenWithholdingAmountstring | nullrequiredpayslipKindstringrequiredtokenCurrencyobject | nullrequiredShow child attributes
currencyIDstringrequiredcurrencyCodestringrequirednamestringrequiredstatusanyrequiredcreatedAtstringrequiredemployeeobjectrequiredShow child attributes
roleInOrgIDstringrequiredfullNamestringrequiredemailstring | nullrequireddepartmentstring | nullrequiredcurrencyobjectrequiredShow child attributes
currencyIDstringrequiredcurrencyCodestringrequirednamestringrequiredfileobject | nullrequiredShow child attributes
fileIDstringrequiredfileNamestringrequiredmimeTypestringrequiredfileSizeInBytesnumber | nullrequireddashboardSummaryobjectrequiredShow child attributes
monthLabelstringrequiredtotalsByCurrencyobject[]requiredShow child attributes
currencyIDstringrequiredcurrencyCodestringrequiredcurrencyNamestringrequiredtotalGrossAmountstringrequiredtotalNetAmountstringrequiredemployeesPaidCountnumberrequiredpendingCountnumberrequired