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

Field

Description

purchase_order_number

An identifier for the purchase, to be displayed on the invoice if it is required.

custom_data

Specifies any custom data that you want to add to the transaction.

buyer_name

The buyer's name. It can be the first name, last name or company name.

currency_code

The ISO currency code for the transaction. For example EUR.

update_timestamp

Date and time of the last transaction update.

note

Add a note to the transaction.

transaction_lines

For more information, see Transaction Lines Object.

buyer_tax_number

The 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_fields

Custom fields, stored as key-value pairs. This property is not processed and used mostly with Taxamo-built helpers.

external_unique_id

A unique, external ID. We advise you to use secure and random identifiers in this field.

vouchers

For more information, see Voucher Object Fields.

customer_id

A free-form field where you can add an identifier that corresponds to the identifier used in your system.

comments

Additional information about the transaction. For example, you can note if the evidence has been amended.

buyer_email

The Buyer's email address. You can use this field when the address needs to be captured for further processing, such as invoice delivery.

tax_timestamp

The 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.

If not provided, tax_timestamp defaults to the value of invoice_timestamp.

You specify it in the following format:
yyyy-MM-dd'T'HH:mm:ssZZZ.

custom_id

Custom identifier provided upon transaction creation.

ship_to_address

For more information, see Address Object Fields.

description

Transaction description.

invoice_timestamp

The moment the invoice has been issued.

This field is used on the invoice document. It also serves as a default value for the tax_timestamp field when no value is specified there.

Defaults to the value of tax_timestamp or the present moment in merchant's timezone.

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



If you need further help, contact support at https://www.vertexinc.com/en-gb/support-services/taxamo-customer-support.

Did this page help you?