Self-serve contractor payments
Self Serve Get Invoice Details
Returns an invoice for admin review with display line items, USD equivalent, parties and payout read model.
Required scope: invoices:read. It also needs banking:read, compensation:read.
curl --request GET \
--url 'https://api.toku.com/hris/self-serve-get-invoice-details?invoiceID=%3CinvoiceID%3E' \
--header 'Authorization: Bearer <token>'{
"invoice": {
"invoicePaymentID": "string",
"invoiceVersion": "string",
"approvalRevision": 0,
"invoiceNumber": "string",
"invoiceDate": "string",
"dueDate": "string",
"totalAmount": "string",
"currencyCode": "string",
"status": "string",
"contractorName": "string",
"contractorEmail": "string",
"submissionTimestamp": "string",
"reason": "string",
"rejectionReason": "string",
"autoApproved": true,
"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"
}
],
"notes": "string",
"createdAt": "string",
"updatedAt": "string",
"approvalRouting": {
"invoiceVersion": "string",
"steps": [
{
"stepOrder": 0,
"kind": "string",
"approverName": "string",
"fallsBackToAdmins": true,
"state": "approved",
"approvedByName": "string",
"approvedByOverride": true
}
],
"currentStepOrder": 0,
"requiredApprovals": 0,
"approvalsCounted": 0,
"waitingOn": "string"
},
"attachments": [
{
"id": "string",
"fileName": "string",
"fileKey": "string",
"fileSize": 0,
"mimeType": "string",
"uploadedAt": "string"
}
],
"groupedTotals": {
"bankTotals": [
{
"currencyCode": "string",
"total": "string"
}
],
"cryptoTotals": [
{
"tokenSymbol": "string",
"networkName": "string",
"total": "string"
}
]
},
"usdEquivalent": 0,
"submissionConversion": {
"sourceCurrencyCode": "string",
"targetAmount": "string",
"targetCurrencyCode": "string",
"rate": "string",
"rateSource": "string",
"rateTimestamp": "string"
},
"isPaymentBatchEligible": true,
"isTokuContractorCryptoInvoice": true,
"billToName": "string",
"billToAddressLines": [
"string"
],
"showTokuBranding": true,
"billFrom": {
"name": "string",
"addressLines": [
"string"
],
"taxId": "string",
"email": "string",
"phone": "string"
},
"isLegacyInvoice": true,
"duplicateCandidates": [
{
"invoicePaymentID": "string",
"invoiceNumber": "string",
"invoiceDate": "string",
"totalAmount": "string",
"currencyCode": "string",
"status": "string",
"matchType": "EXACT_AMOUNT"
}
]
},
"payoutReadModel": {
"source": "CANONICAL_PAYOUT",
"payoutStatus": "NOT_PAID",
"canonicalAvailable": true,
"warnings": [
"string"
],
"legs": [
{
"legType": "FIAT",
"status": "PENDING",
"source": "string",
"amount": "string",
"expectedAmount": "string",
"currencyCode": "string",
"paidAt": "string",
"proofReference": "string",
"transactionHash": "string",
"transactionLink": "string",
"paymentRecordID": "string",
"destinationName": "string",
"destinationAddress": "string",
"tokenSymbol": "string",
"tokenAddress": "string",
"networkName": "string"
}
]
}
}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
invoiceIDstring<uuid>requiredResponse
200Successful response
invoiceobjectrequiredShow child attributes
invoicePaymentIDstringrequiredinvoiceVersionstringrequiredapprovalRevisionnumber | nullinvoiceNumberstring | nullinvoiceDatestring | nulldueDatestring | nulltotalAmountstring | nullcurrencyCodestring | nullstatusstring | nullcontractorNamestring | nullcontractorEmailstring | nullsubmissionTimestampstring | nullreasonstring | nullrejectionReasonstring | nullautoApprovedboolean | nulllineItemsarray | nullShow child attributes
invoicePaymentLineItemIDstring | nulldescriptionstring | nullquantitynumber | nullunitPricenumber | nullamountnumber | nulltaxAmountnumber | nulldiscountAmountnumber | nulltotalnumber | nullcategorystring | nullpaymentMethodTypestring | nullAvailable options: BANK_TRANSFER, CRYPTO_WALLET, null
hrisBankAccountIDstring | nullcryptoCurrencystring | nullcryptoNetworkstring | nullmerchantstring | nullspentAmountstring | nullspentCurrencyCodestring | nullfxRatestring | nullexpensedDatestring | nullbillToSnapshotanynotesstring | nullcreatedAtstring | nullupdatedAtstring | nullapprovalRoutingobject | nullShow child attributes
invoiceVersionstring | nullstepsarray | nullShow child attributes
stepOrdernumber | nullkindstring | nullapproverNamestring | nullfallsBackToAdminsboolean | nullstatestring | nullAvailable options: approved, current, waiting, null
approvedByNamestring | nullapprovedByOverrideboolean | nullcurrentStepOrdernumber | nullrequiredApprovalsnumber | nullapprovalsCountednumber | nullwaitingOnstring | nullattachmentsarray | nullShow child attributes
idstring | nullfileNamestring | nullfileKeystring | nullfileSizenumber | nullmimeTypestring | nulluploadedAtstring | nullgroupedTotalsobject | nullShow child attributes
bankTotalsarray | nullShow child attributes
currencyCodestring | nulltotalstring | nullcryptoTotalsarray | nullShow child attributes
tokenSymbolstring | nullnetworkNamestring | nulltotalstring | nullusdEquivalentnumber | nullsubmissionConversionobject | nullShow child attributes
sourceCurrencyCodestring | nulltargetAmountstring | nulltargetCurrencyCodestring | nullratestring | nullrateSourcestring | nullrateTimestampstring | nullisPaymentBatchEligibleboolean | nullisTokuContractorCryptoInvoiceboolean | nullbillToNamestring | nullbillToAddressLinesarray | nullshowTokuBrandingboolean | nullbillFromobject | nullShow child attributes
namestring | nulladdressLinesarray | nulltaxIdstring | nullemailstring | nullphonestring | nullisLegacyInvoiceboolean | nullduplicateCandidatesarray | nullShow child attributes
invoicePaymentIDstring | nullinvoiceNumberstring | nullinvoiceDatestring | nulltotalAmountstring | nullcurrencyCodestring | nullstatusstring | nullmatchTypestring | nullAvailable options: EXACT_AMOUNT, SIMILAR_AMOUNT, null
payoutReadModelobjectrequiredShow child attributes
sourcestringrequiredAvailable options: CANONICAL_PAYOUT, TOKEN_SETTLEMENT, LEGACY_CONTRACTOR_INVOICE, TRANSACTION_DETAILS, QUEUE_SETTLEMENT_REASON, STATUS_ONLY
payoutStatusstringrequiredAvailable options: NOT_PAID, PARTIALLY_PAID, PAID
canonicalAvailablebooleanrequiredwarningsstring[]requiredlegsobject[]requiredShow child attributes
legTypestringrequiredAvailable options: FIAT, CRYPTO
statusstringrequiredAvailable options: PENDING, PAID, FAILED, CANCELLED
sourcestringrequiredamountstring | nullexpectedAmountstring | nullcurrencyCodestring | nullpaidAtstring | nullproofReferencestring | nulltransactionHashstring | nulltransactionLinkstring | nullpaymentRecordIDstring | nulldestinationNamestring | nulldestinationAddressstring | nulldestinationSnapshotanytokenSymbolstring | nulltokenAddressstring | nullnetworkNamestring | null