Open Invoice fields

openinvoicedata

Field

Type

Required

Description

openinvoicedata.numberOfLines

Integer

(tick)

The number of invoice lines included in openinvoicedata.

There needs to be at least one line, so numberOfLines needs to be at least 1.

openinvoicedata.merchantData String (error)

Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.

The merchantData parameter needs to be added to the openinvoicedata signature at the end.

Since the field is optional, if it's not included it does not impact computing the merchant signature.

Applies only to Klarna.

You can contact Klarna for the format and structure of the string.

openinvoicedata.installmentConfigurationKey String (error) Required for the Klarna account, identifying an installment plan. Include Klarna’s pclassid for the installment plan.

openinvoicedata.line

A container for a specific line.

The <lineNr> placeholder is replaced with an integer that increments by one unit.

Field

Type

Required

Description

openinvoicedata.line<lineNr>.currencyCode

String

(tick)

The three-character ISO currency code.

openinvoicedata.line<lineNr>.description

String

(tick)

A text description of the product the invoice line refers to.

openinvoicedata.line<lineNr>.itemAmount

Integer
(long)

(tick)

The price for one item in the invoice line, represented in minor units.

The due amount for the item, VAT excluded.

openinvoicedata.line<lineNr>.itemVatAmount

Integer
(long)

(tick)

The VAT due for one item in the invoice line, represented in minor units.

openinvoicedata.line<lineNr>.itemVatPercentage

Integer
(long)

(tick)

The VAT percentage for one item in the invoice line, represented in minor units.

For example, 19% VAT is specified as 1900.

openinvoicedata.line<lineNr>.itemId

String

(error)

A unique id for this item. Required for RatePay if the description of each item is not unique.

openinvoicedata.line<lineNr>.numberOfItems

Integer

(tick)

The number of units purchased of a specific product.

openinvoicedata.line<lineNr>.vatCategory

Enum

(tick)

The country-specific VAT category a product falls under.
Allowed values:

  • High
  • Low
  • None