PaginatedResponse[TransactionResponse]

  • cursors
    Type: object · CursorInfo
    required
    • after
      Type: string · After nullable
    • before
      Type: string · Before nullable
    • has_next
      Type: boolean · Has Next
    • has_previous
      Type: boolean · Has Previous
    • limit
      Type: integer · Limit

      Integer numbers.

  • data
    Type: array object[] · Data
    required
    • addresses
      Type: object · TransactionAddresses
      required

      All addresses associated with the transaction (billing, shipping, ship-from, supplier)

    • amounts
      Type: object · TransactionAmounts
      required

      Aggregated monetary breakdown of the transaction (totals, discounts, taxable/non-taxable splits)

    • 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

    • customer_details
      Type: object · TransactionCustomerDetails
      required

      Resolved customer information including the full customer record if one was matched or created

    • 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

    • 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

    • 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

    • 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