Payroll runs & approvals
Get Payroll Run For Client Review
Name and signature indicate it gets payroll run for client review
GEThttps://api.toku.com/hris/get-payroll-run-for-client-review
Required scope: payroll:read. It also needs compensation:read.
curl --request GET \
--url 'https://api.toku.com/hris/get-payroll-run-for-client-review?payrollRunID=%3CpayrollRunID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"payrollRunID": "string",
"countryCode": "string",
"payPeriodStart": "string",
"payPeriodEnd": "string",
"payFrequency": "MONTHLY",
"status": "DRAFT",
"totalGrossPay": "string",
"totalNetPay": "string",
"currency": "string",
"totalsByCurrency": [
{
"currency": "string",
"totalGrossPay": "string",
"totalNetPay": "string"
}
],
"lineItems": [
{
"payrollLineItemID": "string",
"employeeName": "string",
"grossPay": "string",
"netPay": "string",
"currency": "string"
}
],
"approvals": [
{
"payrollRunApprovalID": "string",
"order": 0,
"state": "PENDING",
"comment": "string",
"decidedAt": "string",
"approverName": "string",
"isMe": true
}
],
"awaitingMyApproval": true,
"canApprove": true,
"appliedApprovalPolicies": [
{
"name": "string",
"reason": "string"
}
]
}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.
Query parameters
payrollRunIDstring<uuid>requiredResponse
200Successful response
payrollRunIDstringrequiredcountryCodestringrequiredpayPeriodStartstringrequiredpayPeriodEndstringrequiredpayFrequencystringrequiredAvailable options: MONTHLY, SEMI_MONTHLY, BIWEEKLY, WEEKLY, QUARTERLY, ANNUAL, ONE_TIME
statusstringrequiredAvailable options: DRAFT, PARSING, MAPPED, MATCHING, VALIDATING, REVIEW, APPROVED, FINALIZED, REJECTED, PENDING_CLIENT_APPROVAL, CLIENT_REJECTED, CLIENT_REQUESTED_MODIFICATION
totalGrossPaystring | nullrequiredtotalNetPaystring | nullrequiredcurrencystring | nullrequiredtotalsByCurrencyobject[]requiredShow child attributes
currencystringrequiredtotalGrossPaystringrequiredtotalNetPaystringrequiredlineItemsobject[]requiredShow child attributes
payrollLineItemIDstringrequiredemployeeNamestringrequiredgrossPaystringrequirednetPaystringrequiredcurrencystringrequiredapprovalsobject[]requiredShow child attributes
payrollRunApprovalIDstringrequiredordernumberrequiredstatestringrequiredAvailable options: PENDING, APPROVED, REJECTED, REQUESTED_MODIFICATION
commentstring | nullrequireddecidedAtstring | nullrequiredapproverNamestringrequiredisMebooleanrequiredawaitingMyApprovalbooleanrequiredcanApprovebooleanrequiredappliedApprovalPoliciesobject[]requiredShow child attributes
namestringrequiredreasonstringrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits