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

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
invoiceobjectrequired
Show child attributes
idstringrequired
numberstringrequired
typestringrequired

Available options: DEPOSIT, PRE_FUNDING, FINAL, PLATFORM, CREDIT_NOTE

billingPeriodstring | nullrequired
issueDatestring | nullrequired
dueDatestring | nullrequired
paidDatestring | nullrequired
totalstringrequired
amountDuestringrequired
creditedAmountstringrequired
currencystringrequired
statusstringrequired

Available options: DUE, OVERDUE, PAID, VOID, CREDITED, CREDIT

daysOverdueinteger | nullrequired
daysUntilDueinteger | nullrequired
creditsobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
replacedByobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
replacesobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
beingCorrectedbooleanrequired
todaystringrequired
billedByobjectrequired
Show child attributes
namestringrequired
addressstring | nullrequired
vatNumberstring | nullrequired
billedToobjectrequired
Show child attributes
namestringrequired
addressstring | nullrequired
referencestringrequired
fxRateDatestring | nullrequired
notesstring | nullrequired
paymentInstructionsstring | nullrequired
sentTostring[]required
chargesobject[]required
Show child attributes
itemstringrequired
descriptionstringrequired
quantitynumberrequired
ratestring | nullrequired
amountstringrequired
peopleobject[]required
Show child attributes
labelstringrequired
countrystring | nullrequired
localCurrencystringrequired
localAmountstringrequired
exchangeRatestring | nullrequired
paystringrequired
feesstringrequired
totalstringrequired
breakdownobject[]required
Show child attributes
labelstringrequired
localAmountstringrequired
isInvoiceChargebooleanrequired
relatedobject[]required
Show child attributes
idstringrequired
numberstringrequired
typestringrequired

Available options: DEPOSIT, PRE_FUNDING, FINAL, PLATFORM, CREDIT_NOTE

billingPeriodstring | nullrequired
issueDatestring | nullrequired
dueDatestring | nullrequired
paidDatestring | nullrequired
totalstringrequired
amountDuestringrequired
creditedAmountstringrequired
currencystringrequired
statusstringrequired

Available options: DUE, OVERDUE, PAID, VOID, CREDITED, CREDIT

daysOverdueinteger | nullrequired
daysUntilDueinteger | nullrequired
creditsobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
replacedByobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
replacesobject | nullrequired
Show child attributes
idstringrequired
numberstringrequired
beingCorrectedbooleanrequired
documentsobjectrequired
Show child attributes
invoicePdfbooleanrequired
detailedPdfbooleanrequired
summaryPdfbooleanrequired
workingsbooleanrequired
activityobject[]required
Show child attributes
labelstringrequired
datestringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits