General

This service documentation is still being edited and not yet finished.

CreateInvoice

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

The result is an invoice specification that looks like this.

View in playground

Request


JSON Gateway request

PoNumber

Purchase order number. Always optional. If not provided, you can consider removing the corresponding field from the PDF template.

Type
Required

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

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

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

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

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

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

Name of a product group.

ProductOrderIndex

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

ProductGroupOrderIndex

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

ProductId

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

ProductName
Required

Name of the invoiced product/service.

Quantity
Required

Quantity of units.

UnitOfMeasurement

Unit of measurement

PricePerUnit
Required

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

DiscountPercentage

Discount percentage on the invoiced product/service

TotalDiscount

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

VatPercentage
Required

VAT percentage.

TotalVat
Required

Total VAT amount.

TotalAmountExVat

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

TotalAmount

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.

JSON

copy
{
   "Invoice": "Billingtest101",
   "Description": "buckaroo_schema_test_PDF",
   "Currency": "EUR",
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "CreateInvoice",
            "Parameters": [
               {
                  "Name": "InvoiceAmount",
                  "Value": "217.80"
               },
               {
                  "Name": "InvoiceDate",
                  "Value": "2020-07-08"
               },
               {
                  "Name": "DueDate",
                  "Value": "2021-09-28"
               },
               {
                  "Name": "SchemeKey",
                  "Value": "xxxxx"
               },
               {
                  "Name": "Code",
                  "GroupType": "Debtor",
                  "Value": "johnsmith1"
               },
               {
                  "Name": "PoNumber",
                  "Value": "PO-12345"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "Toys"
               },
               {
                  "Name": "ProductGroupOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "1"
               },
               {
                  "Name": "ProductOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "1"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "Regular"
               },
               {
                  "Name": "ProductId",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "ART12"
               },
               {
                  "Name": "ProductName",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "Blue car"
               },
               {
                  "Name": "Quantity",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "3.00"
               },
               {
                  "Name": "UnitOfMeasurement",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "piece(s)"
               },
               {
                  "Name": "PricePerUnit",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "10.00"
               },
               {
                  "Name": "DiscountPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "20.00"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "6.00"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "21.00"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "6.30"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "17.70"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "1",
                  "Value": "24.00"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "Regular"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "Toys"
               },
               {
                  "Name": "ProductGroupOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "1"
               },
               {
                  "Name": "ProductOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "2"
               },
               {
                  "Name": "ProductId",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "ART13"
               },
               {
                  "Name": "ProductName",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "Yellow train"
               },
               {
                  "Name": "Quantity",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "2.00"
               },
               {
                  "Name": "UnitOfMeasurement",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "piece(s)"
               },
               {
                  "Name": "PricePerUnit",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "5.00"
               },
               {
                  "Name": "DiscountPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "10.00"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "1.00"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "6.00"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "0.60"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "8.40"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "2",
                  "Value": "9.00"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "Candy"
               },
               {
                  "Name": "ProductGroupOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "2"
               },
               {
                  "Name": "ProductOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "1"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "Regular"
               },
               {
                  "Name": "ProductId",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "ART14"
               },
               {
                  "Name": "ProductName",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "Red lollipop"
               },
               {
                  "Name": "Quantity",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "100.00"
               },
               {
                  "Name": "UnitOfMeasurement",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "Kg"
               },
               {
                  "Name": "PricePerUnit",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "1.00"
               },
               {
                  "Name": "DiscountPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "5.00"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "5.00"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "21.00"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "21.00"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "74.00"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "3",
                  "Value": "95.00"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "Candy"
               },
               {
                  "Name": "ProductGroupOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "2"
               },
               {
                  "Name": "ProductOrderIndex",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "2"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "Regular"
               },
               {
                  "Name": "ProductId",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "ART15"
               },
               {
                  "Name": "ProductName",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "Chocolate bar"
               },
               {
                  "Name": "Quantity",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "60.00"
               },
               {
                  "Name": "UnitOfMeasurement",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "Kg"
               },
               {
                  "Name": "PricePerUnit",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "2.00"
               },
               {
                  "Name": "DiscountPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "8.00"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "9.60"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "6.00"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "7.20"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "103.20"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "4",
                  "Value": "110.40"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "Toys"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "Subtotal"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "6.90"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "16.10"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "7.00"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "5",
                  "Value": "33"
               },
               {
                  "Name": "ProductGroupName",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "Candy"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "Subtotal"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "28.20"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "177.20"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "14.60"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "6",
                  "Value": "205.40"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "7",
                  "Value": "Discount"
               },
               {
                  "Name": "TotalDiscount",
                  "GroupType": "ProductLine",
                  "GroupID": "7",
                  "Value": "21.60"
               },
               {
                  "Name": "ProductName",
                  "GroupType": "ProductLine",
                  "GroupID": "7",
                  "Value": "Total discount"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "8",
                  "Value": "TotalAmountExVat"
               },
               {
                  "Name": "TotalAmountExVat",
                  "GroupType": "ProductLine",
                  "GroupID": "8",
                  "Value": "181.70"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "9",
                  "Value": "TotalVat"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "9",
                  "Value": "6"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "9",
                  "Value": "7.80"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "10",
                  "Value": "TotalVat"
               },
               {
                  "Name": "VatPercentage",
                  "GroupType": "ProductLine",
                  "GroupID": "10",
                  "Value": "21"
               },
               {
                  "Name": "TotalVat",
                  "GroupType": "ProductLine",
                  "GroupID": "10",
                  "Value": "27.30"
               },
               {
                  "Name": "Type",
                  "GroupType": "ProductLine",
                  "GroupID": "11",
                  "Value": "TotalAmount"
               },
               {
                  "Name": "TotalAmount",
                  "GroupType": "ProductLine",
                  "GroupID": "11",
                  "Value": "216.80"
               }
            ]
         }
      ]
   }
}

Response


JSON gateway response

JSON

copy
{
   "Key": "873A30BCD20E46E79BFF19046DF25XXX",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2020-07-08T11:37:39"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "CreditManagement3",
         "Action": null,
         "Parameters": [
            {
               "Name": "InvoiceKey",
               "Value": "A89EBBD64F09414094A1176142B86D4F"
            },
            {
               "Name": "DebtorGuid",
               "Value": "6569DAB8486B48E69D64005044CCFBF2"
            },
            {
               "Name": "InvoicePayLink",
               "Value": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=XXX"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": {
      "List": [
         {
            "Name": "InvoiceSpecificationDownloadUrl",
            "Value": "https://static.buckaroo.nl/MerchantContent/dan5vT9hv4byLhKCbxx"
         }
      ]
   },
   "RequestErrors": null,
   "ServiceCode": "CreditManagement3",
   "IsTest": true,
   "ConsumerMessage": null
}