Payslips & compensation

Get Hris Payslips For Org

Lists org payslips with search, period and department filters, sorting, pagination and a monthly dashboard summary.

POSThttps://api.toku.com/hris/get-hris-payslips-for-org

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
}'
200 response
{
  "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

Authorizationstringheaderrequired

Bearer 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

summaryOnlyboolean
searchstring

NOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it

Allowed: at most 100 characters

periodKeystring

Allowed: matches ^\d{4}-(0[1-9]|1[0-2])$

departmentstring

NOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it Filters to one department. Blank is the same as omitted.

sortBystring

Available options: employee, payslipDate, grossAmount, netAmount, digitalAssetGross, digitalAssetNet

sortDirectionstring

Available options: asc, desc

limitinteger

Allowed: 1 to 20000

Default: 10

offsetinteger

Allowed: at least 0

Default: 0

Response

200Successful response
totalCountnumberrequired
hasDigitalAssetPayslipsbooleanrequired
payslipsobject[]required
Show child attributes
hrisPayslipIDstringrequired
roleInOrgIDstringrequired
payslipDatestringrequired
payPeriodLabelstringrequired
grossAmountstringrequired
employeeWithholdingAmountstringrequired
deductionsAmountstringrequired
netAmountstringrequired
digitalAssetGrossstring | nullrequired
digitalAssetNetstring | nullrequired
tokenWithholdingAmountstring | nullrequired
payslipKindstringrequired
tokenCurrencyobject | nullrequired
Show child attributes
currencyIDstringrequired
currencyCodestringrequired
namestringrequired
statusanyrequired
createdAtstringrequired
employeeobjectrequired
Show child attributes
roleInOrgIDstringrequired
fullNamestringrequired
emailstring | nullrequired
departmentstring | nullrequired
currencyobjectrequired
Show child attributes
currencyIDstringrequired
currencyCodestringrequired
namestringrequired
fileobject | nullrequired
Show child attributes
fileIDstringrequired
fileNamestringrequired
mimeTypestringrequired
fileSizeInBytesnumber | nullrequired
dashboardSummaryobjectrequired
Show child attributes
monthLabelstringrequired
totalsByCurrencyobject[]required
Show child attributes
currencyIDstringrequired
currencyCodestringrequired
currencyNamestringrequired
totalGrossAmountstringrequired
totalNetAmountstringrequired
employeesPaidCountnumberrequired
pendingCountnumberrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits