Requests with product lines

Requests with product lines


CreateInvoice

Here is an example of a CreateInvoice request with every ProductLine parameter provided.

The result is an invoice specification that looks like this.

CreateInvoice request

Parameters

Service specific parameters

Parameter Type Required header
PoNumber string Purchase order number. Always optional. If not provided, you can consider removing the corresponding field from the PDF template.
Type string Yes Value: Regular. The Regular invoice line is used to provide information on an invoiced product/service. It is required to provide at least 1 Regular Type.
Type string Value: SubTotal. The Subtotal invoice line can be provided to display the totals of a product group, like TotalVat, TotalAmountExVat, TotalDiscount and TotalAmount. If used, then it is required to refer to a ProductGroupName.
Type string Value: Discount. The Discount invoice line can be used to display the total discount amount over the whole invoice or product group. For the latter it is required to refer to a ProductGroupName.
Type string Value: TotalAmountExVat. The TotalAmountExVat invoice line shows the total amount VAT excluded over the whole invoice. It is calculated and shown automatically at the end of the invoice specification. However, it is optional to overwrite this invoice line with your own data by providing this invoice line type.

Type
string
Value: TotalVat. The TotalVat invoice line shows the total VAT amount over the whole invoice. It is calculated and shown automatically at the end of the invoice specification. However, it is optional to overwrite this invoice line with your own data by providing this invoice line type.

Type
string
Value: TotalAmount. The TotalAmount invoice line shows the total amount over the whole invoice. It is calculated and shown automatically at the end of the invoice specification. However, it is optional to overwrite this invoice line with your own data by providing this invoice line type.

ProductGroupName
string
Name of a product group.

ProductOrderIndex
integer
Position index of the product within a list of products or Product Group. If used, it should be unique within a product group.

ProductGroupOrderIndex
string
Position index of the product group on the invoice specification. If used, it should be unique per product group.

ProductId
string
ID of the invoiced product/service, e.g. an article number.

ProductName
string Required
Name of the invoiced product/service.

Quantity
string Required
Quantity of units.

UnitOfMeasurement
string
Unit of measurement

PricePerUnit
decimal Required
Price per unit. Free to decide whether this price is VAT included or not, no calculations are performed with it by Buckaroo.

DiscountPercentage
decimal
Discount percentage on the invoiced product/service

TotalDiscount
decimal
Total discount of the invoiced product, product group or total invoice.

VatPercentage
decimal Required
VAT percentage.

TotalVat
decimal Required
Total VAT amount.

TotalAmountExVat
decimal
Total amount VAT excluded. Required if TotalAmount is not provided. Otherwise it will be calculated and displayed automatically by Buckaroo.

TotalAmount
decimal
Total amount VAT included. Will be calculated by Buckaroo if not provided. Required if TotalAmountExVat is not provided. Otherwise it will be calculated and displayed automatically by Buckaroo.

Basic parameters

Example request


Was dit artikel nuttig?