Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-14384753.8 KB
Invoices

Render Invoice Data

get/invoices/{invoice_id}/render

Path parameters

invoice_idstring required

Response

Successful Response

idstring

The ID of the invoice

dateIssuedstring date required

YYYY/MM/DD

invoiceNumberinteger required
clientDetailsobject required

Details of the customer this invoice is to be sent to

paymentTermsobject[]
paymentInstructionsobject
billingPeriodStartstring date
billingPeriodEndstring date
lineItemsobject[] required

List of line items

taxRatenumber required
totalTaxnumber required
subTotalnumber required
totalDuenumber required
paymentDueDatestring date required

YYYY/MM/DD

totalDiscountnumber
depositAmountnumber
depositDatestring date

YYYY/MM/DD

parentProjectIdstring
recurringFrequency'Weekly' | 'Bi-Weekly' | 'Monthly' | 'Bi-Monthly' | 'Quarterly'

An enumeration.

status'draft' | 'issued' | 'paid' | 'partially paid' | 'overdue' | 'expired' | 'cancelled' | 'archived' | 'uncollectible'

An enumeration.

metadataobject
paymentsobject[]
totalPaidnumber
totalOutstandingnumber

Example response

{
  "biller": {
    "id": "5f7f9c9c-7b1e-4b9f-9c9c-7b1e4b9f9c9c"
  }
}