Client billing portal
Get Client Billing Invoice
Reads one sent invoice and its client-facing lines.
GEThttps://api.toku.com/platform/get-client-billing-invoice
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/platform/get-client-billing-invoice?invoiceID=%3CinvoiceID%3E' \
--header 'Authorization: Bearer <token>'200 response
{
"invoice": {
"id": "string",
"number": "string",
"type": "DEPOSIT",
"billingPeriod": "string",
"issueDate": "string",
"dueDate": "string",
"paidDate": "string",
"total": "string",
"amountDue": "string",
"creditedAmount": "string",
"currency": "string",
"status": "DUE",
"daysOverdue": 0,
"daysUntilDue": 0,
"credits": {
"id": "string",
"number": "string"
},
"replacedBy": {
"id": "string",
"number": "string"
},
"replaces": {
"id": "string",
"number": "string"
},
"beingCorrected": true
},
"today": "string",
"billedBy": {
"name": "string",
"address": "string",
"vatNumber": "string"
},
"billedTo": {
"name": "string",
"address": "string"
},
"reference": "string",
"fxRateDate": "string",
"notes": "string",
"paymentInstructions": "string",
"sentTo": [
"string"
],
"charges": [
{
"item": "string",
"description": "string",
"quantity": 0,
"rate": "string",
"amount": "string"
}
],
"people": [
{
"label": "string",
"country": "string",
"localCurrency": "string",
"localAmount": "string",
"exchangeRate": "string",
"pay": "string",
"fees": "string",
"total": "string",
"breakdown": [
{
"label": "string",
"localAmount": "string"
}
],
"isInvoiceCharge": true
}
],
"related": [
{
"id": "string",
"number": "string",
"type": "DEPOSIT",
"billingPeriod": "string",
"issueDate": "string",
"dueDate": "string",
"paidDate": "string",
"total": "string",
"amountDue": "string",
"creditedAmount": "string",
"currency": "string",
"status": "DUE",
"daysOverdue": 0,
"daysUntilDue": 0,
"credits": {
"id": "string",
"number": "string"
},
"replacedBy": {
"id": "string",
"number": "string"
},
"replaces": {
"id": "string",
"number": "string"
},
"beingCorrected": true
}
],
"documents": {
"invoicePdf": true,
"detailedPdf": true,
"summaryPdf": true,
"workings": true
},
"activity": [
{
"label": "string",
"date": "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
idstringrequirednumberstringrequiredtypestringrequiredAvailable options: DEPOSIT, PRE_FUNDING, FINAL, PLATFORM, CREDIT_NOTE
billingPeriodstring | nullrequiredissueDatestring | nullrequireddueDatestring | nullrequiredpaidDatestring | nullrequiredtotalstringrequiredamountDuestringrequiredcreditedAmountstringrequiredcurrencystringrequiredstatusstringrequiredAvailable options: DUE, OVERDUE, PAID, VOID, CREDITED, CREDIT
daysOverdueinteger | nullrequireddaysUntilDueinteger | nullrequiredcreditsobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredreplacedByobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredreplacesobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredbeingCorrectedbooleanrequiredtodaystringrequiredbilledByobjectrequiredShow child attributes
namestringrequiredaddressstring | nullrequiredvatNumberstring | nullrequiredbilledToobjectrequiredShow child attributes
namestringrequiredaddressstring | nullrequiredreferencestringrequiredfxRateDatestring | nullrequirednotesstring | nullrequiredpaymentInstructionsstring | nullrequiredsentTostring[]requiredchargesobject[]requiredShow child attributes
itemstringrequireddescriptionstringrequiredquantitynumberrequiredratestring | nullrequiredamountstringrequiredpeopleobject[]requiredShow child attributes
labelstringrequiredcountrystring | nullrequiredlocalCurrencystringrequiredlocalAmountstringrequiredexchangeRatestring | nullrequiredpaystringrequiredfeesstringrequiredtotalstringrequiredbreakdownobject[]requiredShow child attributes
labelstringrequiredlocalAmountstringrequiredisInvoiceChargebooleanrequiredrelatedobject[]requiredShow child attributes
idstringrequirednumberstringrequiredtypestringrequiredAvailable options: DEPOSIT, PRE_FUNDING, FINAL, PLATFORM, CREDIT_NOTE
billingPeriodstring | nullrequiredissueDatestring | nullrequireddueDatestring | nullrequiredpaidDatestring | nullrequiredtotalstringrequiredamountDuestringrequiredcreditedAmountstringrequiredcurrencystringrequiredstatusstringrequiredAvailable options: DUE, OVERDUE, PAID, VOID, CREDITED, CREDIT
daysOverdueinteger | nullrequireddaysUntilDueinteger | nullrequiredcreditsobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredreplacedByobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredreplacesobject | nullrequiredShow child attributes
idstringrequirednumberstringrequiredbeingCorrectedbooleanrequireddocumentsobjectrequiredShow child attributes
invoicePdfbooleanrequireddetailedPdfbooleanrequiredsummaryPdfbooleanrequiredworkingsbooleanrequiredactivityobject[]requiredShow child attributes
labelstringrequireddatestringrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits