The Tax Transaction object

id string Unique identifier for the transaction.
object string, value is "tax.transaction" String representing the object’s type. Objects of the same type share the same value.
currency string Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer _ details object The customer’s details, such as address and tax IDs.
line _ items nullable object Includable The tax collected or refunded, by line item.
metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
reference string A custom unique identifier, such as ‘myOrder_123’.
type enum If reversal, this transaction reverses an earlier transaction. Possible enum values reversal Represents a partial or full reversal of an earlier transaction. transaction Represents a customer sale or order.

Create a Transaction from a Calculation

POST / v1 / tax / transactions / create_from_calculation

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

calculation string Required Tax Calculation ID to be used as input when creating the transaction.
reference string Required A custom order or sale identifier, such as ‘myOrder_123’. Must be unique across all transactions, including reversals. The maximum length is 500 characters.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

A Tax Transaction object.

Response

POST / v1 / tax / transactions / create_reversal

Partially or fully reverses a previously created Transaction.

mode enum Required If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed. Possible enum values full The original transaction is fully reversed. partial The provided line item amounts are reversed.
original _ transaction string Required The ID of the Transaction to partially or fully reverse.
reference string Required A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports. The maximum length is 500 characters.
flat _ amount integer Required if mode=partial and line_items nor shipping_cost provided A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.
line _ items array of objects Required if mode=partial and neither shipping_cost nor flat_amount is provided The line item amounts to reverse.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

shipping _ cost object Required if mode=partial and neither line_items nor flat_amount is provided

A new Tax Transaction object representing the reversal.

Response