Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-14384753.8 KB
Invoices

Get Invoice

get/invoices/{invoice_id}

Path parameters

invoice_idstring required

Headers

x-business-idstring required

Response

Successful Response

createdByUserIdstring
dateIssuedstring date required

YYYY/MM/DD

invoiceNumberinteger required
paymentInstructionsobject
billingPeriodStartstring date
billingPeriodEndstring date
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
idstring

The ID of the invoice

totalPaidnumber
totalOutstandingnumber