Sign in
api

get/api/invoices/{invoice_id}/pdf_url/

Path parameters

invoice_idstring required

Either an invoice ID (in the format invoice_<uuid>) or an invoice number (in the format YYMMDD-000001)

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

Changes