Invoices & invoice payments

Admin List Hris Auto Invoice Settings

Pages the org's contractors with auto-invoicing switches, eligibility verdict, amount preview and latest generation outcome.

GEThttps://api.toku.com/hris/admin-list-hris-auto-invoice-settings

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

curl --request GET \
  --url 'https://api.toku.com/hris/admin-list-hris-auto-invoice-settings' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "orgAutoInvoicingEnabled": true,
  "contractorPaySchedule": "MONTHLY",
  "rows": [
    {
      "roleInOrgID": "string",
      "contractorName": "string",
      "contractorEmail": "string",
      "entityName": "string",
      "rate": {
        "amount": "string",
        "type": "string",
        "currency": "string"
      },
      "autoGenerateInvoice": true,
      "invoiceFrequency": "WEEKLY",
      "autoSubmitInvoice": true,
      "autoApproveInvoice": true,
      "eligibility": {
        "eligible": true,
        "reason": "string",
        "structural": true
      },
      "amountPreview": {
        "amount": "string",
        "currencyCode": "string",
        "lineDescription": "string",
        "periodStart": "string",
        "periodEnd": "string"
      },
      "latestGeneration": {
        "outcome": "string",
        "skipReason": "string",
        "errorDetail": "string",
        "periodStart": "string",
        "updatedAt": "string"
      }
    }
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "contractorSeatsWithoutProfile": [
    {
      "roleInOrgID": "string",
      "contractorName": "string",
      "contractorEmail": "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.

Query parameters

roleInOrgIDstring<uuid>
pageinteger

Allowed: at least 1

Default: 1

pageSizeinteger

Allowed: 1 to 200

Default: 50

searchstring

Allowed: at most 200 characters

Response

200Successful response
orgAutoInvoicingEnabledbooleanrequired
contractorPaySchedulestringrequired

Available options: MONTHLY, SEMI_MONTHLY

rowsobject[]required
Show child attributes
roleInOrgIDstringrequired
contractorNamestringrequired
contractorEmailstringrequired
entityNamestring | nullrequired
rateobjectrequired
Show child attributes
amountstring | nullrequired
typestring | nullrequired
currencystring | nullrequired
autoGenerateInvoicebooleanrequired
invoiceFrequencystring | nullrequired

Available options: WEEKLY, BIWEEKLY, MONTHLY, SEMI_MONTHLY, null

autoSubmitInvoicebooleanrequired
autoApproveInvoiceboolean | null
eligibilityobjectrequired
Show child attributes
eligiblebooleanrequired
reasonstring | nullrequired
structuralbooleanrequired
amountPreviewobject | nullrequired
Show child attributes
amountstringrequired
currencyCodestringrequired
lineDescriptionstringrequired
periodStartstringrequired
periodEndstringrequired
latestGenerationobject | nullrequired
Show child attributes
outcomestringrequired
skipReasonstring | nullrequired
errorDetailstring | nullrequired
periodStartstringrequired
updatedAtstringrequired
totalCountnumberrequired
pagenumberrequired
pageSizenumberrequired
contractorSeatsWithoutProfileobject[]required
Show child attributes
roleInOrgIDstringrequired
contractorNamestringrequired
contractorEmailstringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits