Self-serve contractor payments

Self Serve Get Contractor Invoice Details

Returns the contractor's own invoice with display line items, bill-to/bill-from parties and signed attachment URLs.

GEThttps://api.toku.com/hris/self-serve-get-contractor-invoice-details

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/hris/self-serve-get-contractor-invoice-details?invoiceID=%3CinvoiceID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "invoicePaymentID": "string",
  "invoiceNumber": "string",
  "invoiceDate": "string",
  "dueDate": "string",
  "submittedAt": "string",
  "approvedAt": "string",
  "payDate": "string",
  "approvalDeadline": "string",
  "waitingOnApprover": "string",
  "totalAmount": 0,
  "currencyCode": "string",
  "status": "string",
  "rejectionReason": "string",
  "lineItems": [
    {
      "invoicePaymentLineItemID": "string",
      "description": "string",
      "quantity": 0,
      "unitPrice": 0,
      "amount": 0,
      "taxAmount": 0,
      "discountAmount": 0,
      "total": 0,
      "category": "string",
      "paymentMethodType": "BANK_TRANSFER",
      "hrisBankAccountID": "string",
      "cryptoCurrency": "string",
      "cryptoNetwork": "string",
      "merchant": "string",
      "spentAmount": "string",
      "spentCurrencyCode": "string",
      "fxRate": "string",
      "expensedDate": "string"
    }
  ],
  "lineItemExactAmounts": [
    {
      "quantity": "string",
      "unitPrice": "string"
    }
  ],
  "groupedTotals": {
    "bankTotals": [
      {
        "currencyCode": "string",
        "total": "string"
      }
    ],
    "cryptoTotals": [
      {
        "tokenSymbol": "string",
        "networkName": "string",
        "total": "string"
      }
    ]
  },
  "notes": "string",
  "attachments": [
    {
      "id": "string",
      "fileName": "string",
      "fileKey": "string",
      "fileSize": 0,
      "mimeType": "string",
      "uploadedAt": "string",
      "downloadUrl": "string"
    }
  ],
  "billToName": "string",
  "billToAddressLines": [
    "string"
  ],
  "showTokuBranding": true,
  "billFrom": {
    "name": "string",
    "addressLines": [
      "string"
    ],
    "taxId": "string",
    "email": "string",
    "phone": "string"
  },
  "isLegacyInvoice": 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

invoiceIDstring<uuid>required

Response

200Successful response
invoicePaymentIDstringrequired
invoiceNumberstring | null
invoiceDatestring | null
dueDatestring | null
submittedAtstring | null
approvedAtstring | null
payDatestring | null
approvalDeadlinestring | null
waitingOnApproverstring | null
totalAmountnumber | null
currencyCodestring | null
statusstring | null
rejectionReasonstring | null
lineItemsarray | null
Show child attributes
invoicePaymentLineItemIDstring | null
descriptionstring | null
quantitynumber | null
unitPricenumber | null
amountnumber | null
taxAmountnumber | null
discountAmountnumber | null
totalnumber | null
categorystring | null
paymentMethodTypestring | null

Available options: BANK_TRANSFER, CRYPTO_WALLET, null

hrisBankAccountIDstring | null
cryptoCurrencystring | null
cryptoNetworkstring | null
merchantstring | null
spentAmountstring | null
spentCurrencyCodestring | null
fxRatestring | null
expensedDatestring | null
lineItemExactAmountsarray | null
Show child attributes
quantitystringrequired
unitPricestringrequired
groupedTotalsobject | null
Show child attributes
bankTotalsarray | null
Show child attributes
currencyCodestring | null
totalstring | null
cryptoTotalsarray | null
Show child attributes
tokenSymbolstring | null
networkNamestring | null
totalstring | null
notesstring | null
attachmentsarray | null
Show child attributes
idstring | null
fileNamestring | null
fileKeystring | null
fileSizenumber | null
mimeTypestring | null
uploadedAtstring | null
downloadUrlstring | null
billToNamestring | null
billToAddressLinesarray | null
showTokuBrandingboolean | null
billFromobject | null
Show child attributes
namestring | null
addressLinesarray | null
taxIdstring | null
emailstring | null
phonestring | null
isLegacyInvoiceboolean | null
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits