Invoice

Occurrence

Transaction

Subscription

Content

Key	Type	Description
number	string	Comma-separated product names
products	array of Invoice Products	Invoice Product
shippingAmount	int|null	The cost the shopper is charged for shipping the order
currency	string	ISO 4217 of the used currency
test	int	Was the payment simulated? Possible values: 0 for no or 1 for yes
referenceId	string	An internal reference ID used by your system
purpose	string	The purpose of the payment
paymentRequestId	int|null	ID of the Invoice or Payrexx Gateway created through the API
paymentLink	Payment Link|null	Payment Link Invoice/Gateway data
googleAnalyticProducts	array of Google Analytic Products	Google Analytic Product
originalAmount	int	The amount paid by the shopper
refundedAmount	int	The amount refunded to the shopper
custom_fields	array of Custom Fields	Custom Field Only added when the array is not empty

Example

{
  "test": 1,
  "number": "IV_123",
  "currency": "CHF",
  "discount": {
    "code": null,
    "amount": 0,
    "percentage": null
  },
  "products": [
    {
      "sku": null,
      "name": "Product 1",
      "price": 1000,
      "vatRate": "8.1",
      "quantity": 1,
      "description": "[email protected]"
    }
  ],
  "paymentLink": null,
  "referenceId": "Custom API Reference",
  "custom_fields": [
    {
      "name": "E-Mail",
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "originalAmount": 1000,
  "refundedAmount": 0,
  "shippingAmount": null,
  "paymentRequestId": null,
  "googleAnalyticProducts": [
    {
      "price": 10,
      "item_id": 112233,
      "quantity": 1,
      "item_name": "Product 1"
    }
  ]
}

Changelog

2024-12-10

An update to the Invoice Product object.

2021-10-12

The field amount is removed and replaced with two fields providing more details: originalAmount which stores the amount that was paid and refundedAmount which stores the amount refunded to the shopper.

2019-10-15

The type of amount changes from float to int. The price is now displayed in the currency's smallest unit.

An update to the Discount object.

An update to the Invoice Product object.

2019-02-13

An update to the Invoice Product object.