Token payroll

Get Token Payroll Config

Fetches a token payroll with entity and contributors, plus a legacy-shaped copy for old UI.

GEThttps://api.toku.com/stablecoin-payroll/get-token-payroll-config

Required scope: payroll:read. It also needs compensation:read.

curl --request GET \
  --url 'https://api.toku.com/stablecoin-payroll/get-token-payroll-config?tokenPayrollId=%3CtokenPayrollId%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "tokenPayroll": {
    "tokenPayrollID": "string",
    "orgID": "string",
    "payPeriodStart": "string",
    "payPeriodEnd": "string",
    "payDate": "string",
    "payrollSyncedSource": "string",
    "externalPayrollID": "string",
    "fiatCurrency": "string",
    "payrollEntityId": "string",
    "state": "string",
    "type": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "fundingEmailSent": true,
    "payrollGroup": "string",
    "isPlaceholder": true,
    "payrollEntity": {
      "payrollEntityID": "string",
      "name": "string",
      "reportingCurrency": "string",
      "country": "string"
    },
    "tokenTypeID": "string",
    "contributorsInTokenPayroll": [
      {
        "contributorInTokenPayrollID": "string",
        "tokenPayrollID": "string",
        "roleInOrgID": "string",
        "totalPayrollAmount": 0,
        "totalDeductionAmount": 0,
        "netPayrollAmount": 0,
        "roleInOrg": {
          "roleInOrgID": "string",
          "roleInOrgExternalID": 0,
          "externalEmployeeID": "string",
          "person": {
            "fullName": "string",
            "givenName": "string",
            "familyName": "string"
          }
        }
      }
    ]
  },
  "payroll": {
    "id": "string",
    "name": "string",
    "entity": "string",
    "payPeriodStart": "string",
    "payPeriodEnd": "string",
    "payDate": "string",
    "currentStep": "string",
    "state": "string",
    "type": "string",
    "externalPayrollID": "string",
    "fiatCurrency": "string",
    "tokenTypeID": "string",
    "exchangeRate": 0,
    "isStablecoinPayrollComplete": true,
    "isFiatPayrollComplete": true,
    "isSyncedFromHRIS": true,
    "selectedEmployeeIds": [
      "string"
    ],
    "isCsvUploaded": true,
    "createdAt": "string",
    "updatedAt": "string",
    "createdByID": "string",
    "lastModifiedByID": "string",
    "orgID": "string",
    "payrollSyncedSource": "string",
    "fundingEmailSent": true,
    "payrollGroup": "string",
    "isPlaceholder": true
  }
}

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

tokenPayrollIdstringrequired

Allowed: 1 to 200 characters

Response

200Successful response
tokenPayrollobject | null
Show child attributes
tokenPayrollIDstring | null
orgIDstring | null
payPeriodStartstring | null
payPeriodEndstring | null
payDatestring | null
payrollSyncedSourcestring | null
externalPayrollIDstring | null
fiatCurrencystring | null
payrollEntityIdstring | null
statestring | null
typestring | null
importedDataanyrequired
createdAtstring | null
updatedAtstring | null
fundingEmailSentboolean | null
payrollGroupstring | null
isPlaceholderboolean | null
payrollEntityobject | null
Show child attributes
payrollEntityIDstring | null
namestring | null
reportingCurrencystring | null
countrystring | null
tokenTypeIDstring | null
contributorsInTokenPayrollarray | null
Show child attributes
contributorInTokenPayrollIDstring | null
tokenPayrollIDstring | null
roleInOrgIDstring | null
totalPayrollAmountnumber | null
totalDeductionAmountnumber | null
netPayrollAmountnumber | null
roleInOrgobject | null
Show child attributes
roleInOrgIDstring | null
roleInOrgExternalIDnumber | null
externalEmployeeIDstring | null
personobject | null
Show child attributes
fullNamestring | null
givenNamestring | null
familyNamestring | null
payrollobject | null
Show child attributes
idstring | null
namestring | null
entitystring | null
payPeriodStartstring | null
payPeriodEndstring | null
payDatestring | null
currentStepstring | null
statestring | null
typestring | null
externalPayrollIDstring | null
fiatCurrencystring | null
tokenTypeIDstring | null
exchangeRatenumber | null
isStablecoinPayrollCompleteboolean | null
isFiatPayrollCompleteboolean | null
isSyncedFromHRISboolean | null
selectedEmployeeIdsarray | null
importedDataanyrequired
processedDataanyrequired
settlementDataanyrequired
isCsvUploadedboolean | null
createdAtstring | null
updatedAtstring | null
createdByIDstring | null
lastModifiedByIDstring | null
orgIDstring | null
payrollSyncedSourcestring | null
fundingEmailSentboolean | null
payrollGroupstring | null
isPlaceholderboolean | null
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits