Specifications

Field Type Flags Description
account_type String Account type.
One of:
  • PAYABLE
  • RECEIVABLE
amount Decimal Readonly Total amount minus down-payment invoices amounts (ie. expected amount to pay)
attachments Related Nullable Blankable Attachments related to the quotation/invoice/credit note
balance Decimal Readonly Invoice's balance amount
contact Reference Readonly Nullable Billed contact
current_revision Embedded The current quotation/invoice/credit note revision
has_temporary_reference Boolean Readonly Invoices and down-payment invoices references must follow a continuous numbering scheme. So, only charged invoices have a well-defined reference. This indicates if the invoice has a temporary reference
history Related Readonly Nullable Blankable All history actions
id Objectid Readonly Unique identifier of the resource
issuer Reference Readonly User in charge of the quotation/invoice/credit note
notes Related Nullable Blankable Notes related to the quotation/invoice/credit note
organization Reference Readonly Nullable Billed organization
paid Decimal Readonly Invoice's paid amount
payments Related Readonly Nullable Blankable Invoice's related payments
percentage Decimal Down-payment invoice percentage applied on the quotation total amount
reference String Readonly Reference of the quotation/invoice/credit note
related_credit_note Reference Readonly Nullable Invoice's related credit note
related_quotation Reference Readonly Nullable Invoice's related quotation
resource_uri String Readonly URI which represent a specific resource. All references are based upon this scheme
revisions Related Readonly Nullable Blankable All past quotation/invoice/credit note revisions
state String Readonly Down-payment invoice state.
One of:
  • DRAFT
  • REGISTERED
  • OVERDUE
  • PART_PAID
  • PAID
  • CANCELLED
tax_applied Reference Tax applied on the down-payment invoice amount
total Decimal Readonly Total amount