Token payroll
Get Employee Compensation Data
Returns compensation data for every employee in a token payroll.
GEThttps://api.toku.com/stablecoin-payroll/get-employee-compensation-data
Required scope: compensation:read
curl --request GET \
--url 'https://api.toku.com/stablecoin-payroll/get-employee-compensation-data?tokenPayrollID=%3CtokenPayrollID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"employees": [
{
"employeeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"employeeName": "string",
"totalCompensation": 0,
"totalDeduction": 0,
"netPayFiat": 0,
"currency": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}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
tokenPayrollIDstringrequiredAllowed: 1 to 200 characters
Response
200Successful response
employeesobject[]requiredShow child attributes
employeeIdstring<uuid>requiredThe source explicitly converts display amounts with Number: preserve its legacy numeric wire.
employeeNamestringrequiredtotalCompensationnumberrequiredtotalDeductionnumberrequirednetPayFiatnumberrequiredcurrencystringrequiredhasTGAProfileanyrequiredhasValidWalletanyrequiredhasPayrollErroranyrequiredhasMinimumWageErroranyrequiredidstring<uuid>required400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits