TransactionResponse

addresses
Type: object · TransactionAddresses
required

All addresses associated with the transaction (billing, shipping, ship-from, supplier)
- billing
  Type: object · AddressDto nullable
  
  Billing address as submitted
- shipping
  Type: object · ShippingAddressResponse nullable
  
  Shipping destination address, including the geocoded result used to determine the tax jurisdiction
- shipping_from
  Type: object · AddressDto nullable
  
  Ship-from or origin address, used when origin-based tax rules apply
- supplier
  Type: object · AddressDto nullable
  
  Supplier address
amounts
Type: object · TransactionAmounts
required

Aggregated monetary breakdown of the transaction (totals, discounts, taxable/non-taxable splits)
- final_transaction_amount
  Type: string · Final Transaction AmountFormat: decimal nullable
  
  Total value of the transaction after all discounts. If is_tax_inclusive=false, tax is added on top; if true, this already includes tax.
- non_taxable_amount
  Type: string · Non Taxable AmountFormat: decimal nullable
  
  Portion of total_items_amount for items classified as non-taxable
- tangible_items_amount
  Type: string · Tangible Items AmountFormat: decimal nullable
  
  Portion of total_items_amount attributable to tangible items only
- taxable_items_amount
  Type: string · Taxable Items AmountFormat: decimal nullable
  
  Portion of total_items_amount attributable to taxable items only
- total_discount
  Type: string · Total DiscountFormat: decimal nullable
  
  Aggregate of all item-level discounts across all line items
- total_items_amount
  Type: string · Total Items AmountFormat: decimal nullable
  
  Sum of all line item total_price_after_discounts (after per-item discounts, before transaction-level discount)
- transaction_level_discount
  Type: string · Transaction Level DiscountFormat: decimal nullable
  
  Transaction-wide discount that was distributed pro-rata across line items
created_at
Type: string · Created AtFormat: date-time
required

System timestamp when this record was first created
currency_details
Type: object · TransactionCurrencyDetails
required

Currency code, any exchange rate applied, and converted USD amounts
- currency
  Type: string · Currency nullable
  
  Currency code for the transaction amounts (e.g., USD, EUR). If not USD, amounts are also reported in USD via exchange_rate_info.
- exchange_rate_info
  Type: object · ExchangeRateInfoResponse nullable
  
  Full currency conversion details including converted amounts and the rate source
- manual_exchange_rate
  Type: string · Manual Exchange RateFormat: decimal nullable
  
  Manual exchange rate override that was applied to this transaction, if provided
customer_details
Type: object · TransactionCustomerDetails
required

Resolved customer information including the full customer record if one was matched or created
- customer
  Type: object · CustomerResponse nullable
  
  Full resolved customer record, included when a customer was found or inline-created
- customer_external_id
  Type: string · Customer External Id nullable
  
  External system ID of the resolved customer
- customer_id
  Type: string · Customer IdFormat: uuid nullable
  
  Internal UUID of the customer resolved for this transaction
- customer_source
  Type: stringenum nullable
  
  Data source of the resolved customer
  
  values
  netsuite
  priority
  zoho_books
  quickbooks
  salesforce
- customer_type_override
  Type: stringenum nullable
  
  Customer type that was used for this transaction, overriding the customer's default type (affects exemption logic)
  
  values
  retail
  marketplace
  reseller
external_created_at
Type: string · External Created AtFormat: date-time
required

Created timestamp from your system, used for audit and reconciliation
external_id
Type: string · External Id
required

Your system's transaction identifier (e.g., invoice or order number)
external_updated_at
Type: string · External Updated AtFormat: date-time
required

Last-updated timestamp from your system, used for audit and reconciliation
id
Type: string · IdFormat: uuid
required

Internal system UUID for this record
source
Type: string · Source
required

Namespace that scoped the external_id when this transaction was created. Used to uniquely identify the transaction together with external_id.
tax
Type: object · TransactionTaxSummary
required

Total tax summary — aggregate of all item and shipping fee taxes across all jurisdictions
- effective_tax_rate
  Type: string · Effective Tax RateFormat: decimal nullable
  
  Blended effective tax rate for the transaction (total_tax ÷ total taxable amount)
- total_tax
  Type: string · Total TaxFormat: decimal nullable
  
  Total tax amount calculated across all line items and the shipping fee, summed across all jurisdictions
tenant_id
Type: string · Tenant IdFormat: uuid
required

UUID of the tenant that owns this record
updated_at
Type: string · Updated AtFormat: date-time
required

System timestamp of the most recent update to this record
document_name
Type: string · Document Name nullable

ERP or accounting system document reference (e.g., INV-001, SO-123)
is_tax_inclusive
Type: boolean · Is Tax Inclusive nullable

Whether the submitted prices already include tax (true) or whether tax is calculated on top (false)
items
Type: array object[] | null · Items nullable

Line items with full tax calculation results per item and per jurisdiction
- description
  Type: string · Description nullable
  
  Detailed description of the product or service
- discount
  Type: string · DiscountFormat: decimal nullable
  
  Item-level discount amount deducted from total_price before tax calculation
- exemption_id
  Type: string · Exemption IdFormat: uuid nullable
  
  UUID of the exemption certificate that was applied to this item. Only present if the item is exempt.
- exemption_reason
  Type: string · Exemption Reason nullable
  
  Human-readable reason this item is exempt (e.g., resale_certificate, government_entity, customer_fully_exempt)
- is_exempt
  Type: boolean · Is Exempt
  
  True if this item was fully exempted from tax, either via an exemption certificate or customer-level exemption
- jurisdiction_tax_breakdown
  Type: object · Jurisdiction Tax Breakdown nullable
  
  Keys are jurisdiction levels. US: state, county, city, mta, spd. Non-US: country, federal, region, provincial, state. Manual fallback: combined.
- manual_sales_tax_rate
  Type: string · Manual Sales Tax RateFormat: decimal nullable
  
  Manual tax rate override (0–1) submitted at request time. When present, bypasses automatic jurisdiction rate lookup and applies this rate directly.
- name
  Type: string · Name
  max length:
  256 nullable
  
  Short display name or label for the item
- quantity
  Type: string · QuantityFormat: decimal nullable
  
  Number of units for this line item
- relative_transaction_discount
  Type: string · Relative Transaction DiscountFormat: decimal nullable
  
  The portion of the transaction-level discount that was allocated to this line item, calculated pro-rata based on the item's share of the total transaction value
- tangible_category
  Type: stringenum nullable
  
  Whether the item is a physical good (tangible) or a digital product or service (intangible). Affects taxability in many US jurisdictions.
  
  values
  tangible
  intangible
- tax
  Type: object · ItemTaxSummary nullable
  
  Tax amounts calculated for this item
- tax_adjustments
  Type: array string[] | null · Tax Adjustments nullable
  
  Adjustments applied during tax calculation (e.g., manual_tax_rate_applied).
- tax_code
  Type: string · Tax Code
  max length:
  256 nullable
  
  Product tax classification code submitted with the item. Determines tangible/digital and taxable/non-taxable classification during tax calculation.
- taxability_reason
  Type: stringenum nullable
  
  The specific reason this item was classified as taxable or non-taxable (e.g., standard_rated, product_exempt, customer_exempt, zero_rated)
  
  values
  customer_exempt
  not_available
  not_collecting
  not_subject_to_tax
  not_supported
- taxable_category
  Type: stringenum nullable
  
  Whether this item is subject to sales tax. Non-taxable items are excluded from the tax base.
  
  values
  taxable
  not_taxable
- total_price
  Type: string · Total PriceFormat: decimal nullable
  
  Gross line item amount (unit_price × quantity) before any discounts are applied
- total_price_after_discount
  Type: string · Total Price After DiscountFormat: decimal nullable
  
  Final taxable amount for this item after both item-level discount and the item's pro-rata share of the transaction-level discount have been applied. This is the amount on which tax is calculated.
- unit_price
  Type: string · Unit PriceFormat: decimal nullable
  
  Per-item cost before quantity multiplication. Can be negative to represent a credit or refund line.
linked_transaction
Type: string · Linked Transaction nullable

For refunds: the external_id of the original invoice this refund is linked to.
obligation_id
Type: string · Obligation IdFormat: uuid nullable

ID of the obligation governing tax collection for this transaction's jurisdiction and tax type.
override_threshold
Type: boolean · Override Threshold

True when tax was calculated despite threshold not being established. Indicates this transaction bypassed normal threshold rules.
shipping_fee
Type: object · ShippingFeeResponse nullable

Shipping cost with tax calculation result
- jurisdiction_tax_breakdown
  Type: object · Jurisdiction Tax Breakdown nullable
  
  Keys are jurisdiction levels. US: state, county, city, mta, spd. Non-US: country, federal, region, provincial, state. Manual fallback: combined.
- manual_sales_tax_rate
  Type: string · Manual Sales Tax RateFormat: decimal nullable
  
  Manual tax rate override applied to the shipping fee. When present, bypasses automatic jurisdiction rate lookup.
- tangible_category
  Type: stringenum nullable
  
  Tangibility classification of the shipping fee
  
  values
  tangible
  intangible
- tax
  Type: object · ItemTaxSummary nullable
  
  Tax amounts calculated on the shipping fee
- tax_code
  Type: string · Tax Code nullable
  
  Product tax classification code for the shipping fee, used to determine taxability in each jurisdiction
- taxable_category
  Type: stringenum nullable
  
  Whether the shipping fee is subject to sales tax in the applicable jurisdiction
  
  values
  taxable
  not_taxable
- total_price
  Type: string · Total PriceFormat: decimal nullable
  
  Shipping cost submitted on the request. Taxed only if the transaction has at least one taxable item.
- total_price_after_discount
  Type: string · Total Price After DiscountFormat: decimal nullable
  
  Shipping amount used as the tax base after any applicable discounts
tax_collection_status
Type: stringenum nullable

Obligation-driven collection status: actual (collecting), hypothetical (calculated but not collected), suppressed (collection overridden off), enforced (collection overridden on).
values
- actual
- realised
- hypothetical
- suppressed
- enforced
transaction_date
Type: string · Transaction DateFormat: date-time nullable

Issue date of the document, used as the reference date for exemption validity checks
transaction_status
Type: stringenum nullable

Lifecycle state. active: included in tax reports, cancelled: excluded from tax filing reports, paid: finalized and included in filing
values
- active
- cancelled
- paid
transaction_type
Type: stringenum nullable

Document type that determines tax treatment. sales_order: preliminary order (not reported), invoice: taxable sale, estimate: quote (not reported), refund: credit memo — use linked_transaction to link to original invoice and inherit its tax rate period
values
- sales_order
- invoice
- estimate
- refund