Skip to main content
POST
Get payslip download URL

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
hrisPayslipID
string<uuid>
required

Payslip identifier

Response

Successful response

hrisPayslipID
string<uuid>
required

Payslip identifier

fileID
string<uuid>
required

File identifier

fileName
string
required

File name

mimeType
string
required

File MIME type

downloadUrl
string
required

Pre-signed download URL