Skip to main content

The invoice object

Invoice

ParameterData typeDefaultDescription
invoice_numberintNULLThe invoice number for this invoice. This is null until status is booked
statusstringdraftIs the invoice booked or not? Possible values: draft, booked
order_typestringb2bOrder type
customer_idintThe customer of the invoice
order_idintNULLA "manual invoice" has empty order_id
notesstringNULLAn optional note/comment
currencystringThe currency of the invoice
metaobject{}An object with {"key": "value"} with custom meta data of the order. This is used for storing custom fields
total_quantityintThe total invoiced quantity
price_before_discountfloatThe total price of the order before discount and ex VAT
discount_amountfloatThe total discount given as an amount ex VAT
discount_percentagefloatThe total discount given as a percentage
net_pricefloatThe total price of the order ex VAT, shipping and handling fee and after discount
shippingfloatThe shipping amount ex VAT
handling_feefloatThe handling fee amount ex VAT
vat_amountfloatThe total VAT amount
total_price_after_vatfloatThe total price of the order incl VAT
created_atdatetime
updated_atdatetime
lines.*An array of object invoice line

Invoice line

ParameterData typeDefaultDescription
product_idintThe product invoiced
variant_idintThe variant invoiced
quantityintThe quantity invoiced
price_before_discountfloatThe unit price of the line before discount and ex VAT
discount_amountfloatThe unit discount given as an amount ex VAT
discount_percentagefloatThe discount given as a percentage
net_pricefloatThe unit price of the line ex VAT and after discount
vat_amountfloatThe unit VAT amount
total_pricefloatThe total price of the line ex VAT. This is calculated as quantity * net_price
total_price_after_vatfloatThe total price of the line incl VAT
created_atdatetime
updated_atdatetime