This topic lists information about mandatory, deprecated and inactive fields.

Mandatory fields

Mandatory fields can be grouped as:

• Schema Mandatory Fields: Some fields, like custom_id or refund_reason are a required part of the schema. You do not have to include a value but the schema must include these fields.
• Fields that are mandatory due to business requirements. For example, some specific fields are required for Canadian invoices.

Schema mandatory fields

The following fields are mandatory for a valid schema. This means the schema does have to include a value for the field but it must include the field:

• custom_id for transaction lines but not transactions.
• refund_reason
• country_code
• currency_code
• product_class

Mandatory fields per request

The following fields are mandatory for a successful Calculate Tax request:

• country_code
• amount or total_amount
• currency_code
• product_class

The following fields are mandatory for a valid Store Transaction request:

• buyer_name
• amount or total_amount
• country_code
• currency_code
• product_class

Response-only fields (Service Generated)

The following fields are generated by the service. You should not add values to the these fields in your requests:

Inactive fields

The following fields are inactive and should not be used:

• carrier_id
• discounts
• vouchers
• payment_address
• discounted_tax_amount
• product_cn_code
• product_reference_number
• parcel_reference
• discounted_total_amount
• discounted_amount

The following fields cannot be used with the Calculate Tax request:

• invoice_timestamp
• external_unique_id

Deprecated fields

The following fields are deprecated. You can use the alternative field instead: