Transaction Object Fields

Read about what fields you can use and what fields the API returns based on your requests.

The Transaction object refers to the JSON structure that contains most of the information that you need to send to the API.

The object also contains a number of arrays or sub-objects that you can use to represent the following business entities:

  • Transaction details per line item
  • Tax information
  • Addresses
  • Refunds
purchase_order_numberAn identifier for the purchase, to be displayed on the invoice if it is required.
custom_dataSpecifies any custom data that you want to add to the transaction.
buyer_nameThe buyer's name. It can be the first name, last name or company name.
currency_codeThe ISO currency code for the transaction. For example EUR.
update_timestampDate and time of the last transaction update.
noteAdd a note to the transaction.
transaction_linesSee Transaction Lines Object.
buyer_tax_numberThe tax number used by the buyer. For example, the EU VAT number.

You can use this field to provide the country code, if that is part of the number. For example, IE1234567X.

You can also use the billing_country_code field for specifying the country.

If a value is entered in the both fields, the country code value in the buyer_tax_number is used once it is verified.
custom_fieldsCustom fields, stored as key-value pairs. This property is not processed.
external_unique_idA unique, external ID. We advise you to use secure and random identifiers in this field.
vouchersSee Voucher Object Fields.
customer_idA free-form field where you can add an identifier that corresponds to the identifier used in your system.
commentsAdditional information about the transaction. For example, you can note if the evidence has been amended.
buyer_emailThe Buyer's email address. You can use this field when the address needs to be captured for further processing, such as invoice delivery.
tax_timestampThe time when the tax liability is created.

Tax point date is used to find out the correct tax and currency exchange rates. It appears on the invoice too.
It is returned in the following format:
custom_idCustom identifier provided upon transaction creation.
ship_to_addressSee Configuring Addresses.
descriptionTransaction description.
invoice_timestampThe moment the invoice has been issued.

This field is used on the invoice document.

Format is: yyyy-MM-dd'T'HH:mm:ssZZZ.