201Successful Response
Schema: InvoiceResponse
idstringrequiredInvoice UUID.
business_idstringrequiredBusiness UUID.
created_atstring · date-timerequiredCreation timestamp.
updated_atstring · date-timerequiredLast update timestamp.
statusstringrequiredStatus: draft, open, partially_paid, manual_paid, stripe_paid, void.
currencystringCurrency for the invoice (USD, CAD, AUD, EUR, or GBP).
stripe_invoice_idstringStripe invoice ID if synced.
totalintegerTotal amount in cents.
total_paidintegerRunning total of payments received in cents.
balance_dueintegerRemaining balance in cents (total - total_paid).
descriptionstringInvoice description/notes.
customer_idstringrequiredCustomer UUID.
customer_namestringCustomer name (resolved).
customer_emailstringCustomer email (resolved).
due_datestringDue date (YYYY-MM-DD).
line_itemsarray · LineItemResponseInvoice line items.
fulfillment_location_idstringDefault warehouse used for inventory deductions.
pdf_urlstringURL to download invoice PDF.
numberstringInvoice number (assigned on finalize).
deliveredbooleanWhether invoice was delivered.
delivered_onstring · date-timeDelivery timestamp.
hosted_invoice_urlstringURL for customer payment portal.
paid_onstring · date-timePayment timestamp.
journal_entriesarray · objectAssociated accounting journal entries.
paymentsarray · InvoicePaymentResponsePayment records linking bank transactions to this invoice.
recurring_template_idstringID of recurring template if invoice was generated from one, or if one was created.