Invoices

Create a draft invoice

Number, language, texts, VAT treatment and missing values are taken from the settings of the account, exactly as in the web form. The invoice stays a draft until it is sent. Prices are net or gross depending on the setting "Prices" of the account; if prices_include_tax differs from that setting, the API refuses the request with 422.

post/invoices

Request

  • Base URL: https://www.billingengine.com/api/v1
  • URL: https://www.billingengine.com/api/v1/invoices
  • Auth: HTTP bearer

Request body

customer_idinteger

Required when creating an invoice.

datestring date
due_daysinteger
opening_textstring
closing_textstring
service_period_start_datestring date
service_period_end_datestring date
prices_include_taxboolean

true for gross prices, false for net prices. If it differs from the account setting, the request is refused with 422.

Response

The created invoice.

idinteger
numberstring
datestring date
due_datestring date nullable
delivery_status'draft' | 'sent' | 'downloaded'
payment_status'open' | 'paid' | 'defaulted' | 'cancelled' | 'cancellation'
overdueboolean
cancelledboolean
cancellationboolean

True for a cancellation invoice (credit note) of another invoice.

currencystring
prices_include_taxboolean
net_amountnumber
tax_amountnumber
gross_amountnumber
open_amountnumber
original_invoice_numberstring nullable
languagestring
vat_treatment'standard' | 'exempt' | 'reverse_charge' | 'intra_community' | 'export_outside_eu' | 'zero_rated' | 'outside_scope'
service_period_start_datestring date nullable
service_period_end_datestring date nullable
opening_textstring nullable
closing_textstring nullable

Example response

{
  "currency": "EUR",
  "language": "de"
}

Changes

No recorded changes to this operation across all 1 revision of this API.