Client billing portal
List Client Billing History
Lists only the invoices sent to the selected organization with its totals.
GEThttps://api.toku.com/platform/list-client-billing-history
Not available to API keys.
curl --request GET \
--url 'https://api.toku.com/platform/list-client-billing-history' \
--header 'Authorization: Bearer <token>'200 response
{
"invoices": [
{
"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
}
],
"totals": [
{
"currency": "string",
"outstanding": "string",
"outstandingCount": 0,
"overdue": "string",
"overdueCount": 0,
"mostDaysOverdue": 0,
"paidThisYear": "string",
"paidThisYearCount": 0,
"lastPaidDate": "string",
"nextDue": {
"id": "string",
"number": "string",
"dueDate": "string",
"amountDue": "string",
"type": "DEPOSIT",
"billingPeriod": "string"
}
}
],
"today": "string",
"truncated": true
}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.
Response
200Successful response
invoicesobject[]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
idstringrequirednumberstringrequiredbeingCorrectedbooleanrequiredtotalsobject[]requiredShow child attributes
currencystringrequiredoutstandingstringrequiredoutstandingCountintegerrequiredoverduestringrequiredoverdueCountintegerrequiredmostDaysOverdueintegerrequiredpaidThisYearstringrequiredpaidThisYearCountintegerrequiredlastPaidDatestring | nullrequirednextDueobject | nullrequiredShow child attributes
idstringrequirednumberstringrequireddueDatestringrequiredamountDuestringrequiredtypestringrequiredAvailable options: DEPOSIT, PRE_FUNDING, FINAL, PLATFORM, CREDIT_NOTE
billingPeriodstring | nullrequiredtodaystringrequiredtruncatedbooleanrequired400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits