Payslips & compensation

Get Hris Payslips For Role In Org

Lists one employee's non-deleted payslips for a client admin.

GEThttps://api.toku.com/hris/get-hris-payslips-for-role-in-org

Required scope: compensation:read

curl --request GET \
  --url 'https://api.toku.com/hris/get-hris-payslips-for-role-in-org?roleInOrgID=%3CroleInOrgID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
[
  {
    "hrisPayslipID": "string",
    "roleInOrgID": "string",
    "payslipDate": "string",
    "payPeriodLabel": "string",
    "grossAmount": "string",
    "employeeWithholdingAmount": "string",
    "netAmount": "string",
    "digitalAssetGross": "string",
    "digitalAssetNet": "string",
    "tokenWithholdingAmount": "string",
    "payslipKind": "COMBINED",
    "createdAt": "string",
    "currency": {
      "currencyID": "string",
      "currencyCode": "string",
      "name": "string"
    },
    "tokenCurrency": {
      "currencyID": "string",
      "currencyCode": "string",
      "name": "string"
    },
    "components": [
      {
        "hrisPayslipComponentID": "string",
        "type": "EARNING",
        "category": "string",
        "label": "string",
        "amount": "string",
        "tokenUnits": "string",
        "fmvRate": "string",
        "sortOrder": 0,
        "currencyCode": "string"
      }
    ],
    "file": {
      "fileID": "string",
      "fileName": "string",
      "mimeType": "string",
      "fileSizeInBytes": 0
    },
    "createdBy": {
      "roleInOrgID": "string",
      "fullName": "string",
      "email": "string"
    }
  }
]

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.

Query parameters

roleInOrgIDstring<uuid>required

Response

200Successful response
hrisPayslipIDstringrequired
roleInOrgIDstringrequired
payslipDatestringrequired
payPeriodLabelstringrequired
grossAmountstringrequired
employeeWithholdingAmountstringrequired
netAmountstringrequired
digitalAssetGrossstring | nullrequired
digitalAssetNetstring | nullrequired
tokenWithholdingAmountstring | nullrequired
payslipKindstringrequired

Available options: COMBINED, FIAT, TOKEN

createdAtstringrequired
currencyobjectrequired
Show child attributes
currencyIDstringrequired
currencyCodestringrequired
namestringrequired
tokenCurrencyobject | nullrequired
Show child attributes
currencyIDstringrequired
currencyCodestringrequired
namestringrequired
componentsobject[]required
Show child attributes
hrisPayslipComponentIDstringrequired
typestringrequired

Available options: EARNING, DEDUCTION, EMPLOYER_CONTRIBUTION

categorystringrequired
labelstringrequired
amountstringrequired
tokenUnitsstring | nullrequired
fmvRatestring | nullrequired
sortOrderintegerrequired
currencyCodestring | nullrequired
fileobject | nullrequired
Show child attributes
fileIDstringrequired
fileNamestringrequired
mimeTypestringrequired
fileSizeInBytesnumber | nullrequired
createdByobjectrequired
Show child attributes
roleInOrgIDstringrequired
fullNamestringrequired
emailstring | nullrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits