Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

get/api/invoices/

Query parameters

customer_idstring nullable

A filter for invoices for a specific customer

payment_statusstring[]

A filter for invoices with a specific payment status

Response

invoice_idstring required
invoice_numberstring required
cost_duenumber double required
amountnumber double required
issue_datestring date-time required
payment_status'draft' | 'voided' | 'paid' | 'unpaid' required
  • draft - draft
  • voided - voided
  • paid - paid
  • unpaid - unpaid
external_payment_obj_idstring nullable required
external_payment_obj_type'stripe' | 'braintree' | 'null' nullable required
  • stripe - Stripe
  • braintree - Braintree
external_payment_obj_statusstring nullable
due_datestring date-time nullable required
start_datestring date required
end_datestring date required
invoice_pdfstring uri nullable required