buezli.app API

/2026-07-14/invoices

Invoice

Invoices contain customer billing details, line items, payments, totals and payment status.

Endpoints

GET /2026-07-14/invoices/:id/pdf Download PDF

Example request

curl \
  -H "Authorization: Bearer $BUEZLI_API_TOKEN" \
  "https://api.buezli.app/2026-07-14/invoices/123/pdf"
GET /2026-07-14/invoices List records

Example request

curl \
  -H "Authorization: Bearer $BUEZLI_API_TOKEN" \
  "https://api.buezli.app/2026-07-14/invoices?page=1&limit=50"
GET /2026-07-14/invoices/:id Retrieve one record

Example request

curl \
  -H "Authorization: Bearer $BUEZLI_API_TOKEN" \
  "https://api.buezli.app/2026-07-14/invoices/123"

Fields

FieldTypeDescription
idintegerUnique identifier for the resource.
created_atdatetimeTimestamp when the resource was created.
updated_atdatetimeTimestamp when the resource was last updated.
client_idintegerID of the client billed by the invoice.
source_estimate_idintegerID of the estimate from which the invoice was created.
numberstringInvoice number shown to the customer and unique within the workspace.
statusstringLifecycle status: draft, sent, late, paid, void or closed.
issue_datedateDate shown as the invoice issue date.
due_datedateDate by which the invoice should be paid.
subjectstringCustomer-facing subject of the invoice.
notesstringCustomer-facing notes printed on the invoice.
currencystringISO 4217 currency code used for invoice amounts.
localestringLanguage code used for customer-facing invoice labels.
recipient_namestringCustomer name preserved on the invoice.
recipient_addressstringCustomer address preserved on the invoice.
sender_namestringSender name preserved on the invoice.
sender_addressstringSender address preserved on the invoice.
sender_emailstringSender email address preserved on the invoice.
sender_phonestringSender phone number preserved on the invoice.
sender_vat_numberstringSender VAT registration number preserved on the invoice.
sender_ibanstringSender IBAN preserved for invoice payment instructions.
payment_referencestringPayment reference printed on the invoice and QR bill.
tax_ratedecimalDefault tax percentage inherited by line items without an override.
discount_ratedecimalPercentage discount applied to the invoice.
subtotalmoneySum of invoice line items before discounts and taxes.
discountmoneyDiscount amount deducted from the invoice subtotal.
taxmoneySum of tax calculated once for each effective tax-rate bucket.
tax_breakdownarrayTaxable amount and tax amount grouped by exact effective tax rate.
totalmoneyFinal invoice total after discounts and taxes.
paidmoneyTotal amount recorded as paid on the invoice.
duemoneyOutstanding invoice amount after recorded payments.
sent_atdatetimeTimestamp when the invoice was marked as sent.
paid_atdatetimeTimestamp when the invoice became fully paid.
voided_atdatetimeTimestamp when the invoice was voided.
void_reasonstringReason recorded when the invoice was voided.
archived_atdatetimeTimestamp when the invoice was archived, or null when active.
recurring_invoice_template_idintegerID of the recurring template that generated the invoice.
recurring_occurrence_ondateScheduled occurrence date that produced the recurring invoice.
pdfdownloadAvailability and API download path for the generated invoice PDF.

Relationships

client

Returned as an ID. Add expand=client to include the related record.

source_estimate

Returned as an ID. Add expand=source_estimate to include the related record.

recurring_invoice_template

Returned as an ID. Add expand=recurring_invoice_template to include the related record.

line_items

Included in every response.

payments

Included in every response.