Self-serve contractor payments

Self Serve Export Payment History Csv

Builds a CSV of the org's payment history for the given filters and logs a REPORT_EXPORTED audit row.

POSThttps://api.toku.com/hris/self-serve-export-payment-history-csv

Not available to API keys yet. It will need reports:write.

curl --request POST \
  --url 'https://api.toku.com/hris/self-serve-export-payment-history-csv' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "DRAFT",
  "dateFrom": "2026-01-01T00:00:00Z",
  "dateTo": "2026-01-01T00:00:00Z"
}'
200 response
{
  "csv": "string",
  "filename": "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.

Body

application/json

statusstring

Available options: DRAFT, PROPOSED, EXECUTED, FAILED, CANCELLED

dateFromstring<date-time>
dateTostring<date-time>

Response

200Successful response
csvstring
filenamestring
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits