TransactionUpsertRequest

  • external_id
    Type: string · External Id
    min length:  
    1
    max length:  
    256
    required

    Unique identifier from your system

  • source
    Type: string · DataSourceenum
    required

    Namespace that scopes external_id to prevent collisions across integrations. All transactions sharing the same source must have unique external_ids.

    values
    • netsuite
    • priority
    • zoho_books
    • quickbooks
    • salesforce
  • transaction_date
    Type: string · Transaction DateFormat: date-time
    required

    Issue date of document

  • addresses
    Type: object · TransactionAddressesRequest nullable

    Transaction addresses (billing, shipping, etc.)

    • billing
      Type: object · AddressDto nullable

      Billing address

    • shipping
      Type: object · ShippingAddressRequest nullable

      Shipping destination address (used for tax jurisdiction)

    • shipping_from
      Type: object · AddressDto nullable

      Ship-from / origin address

    • supplier
      Type: object · AddressDto nullable

      Supplier address

  • currency_details
    Type: object · TransactionCurrencyDetailsRequest nullable

    Currency and exchange rate information

    • currency
      Type: string · Currency nullable

      Currency code (e.g., USD, EUR)

    • manual_exchange_rate
      Type: string · Manual Exchange RateFormat: decimal nullable

      Manual exchange rate override

  • customer_details
    Type: object · TransactionCustomerDetailsRequest nullable

    Customer reference information

    • customer
      Type: object · EmbeddedCustomerRequest nullable

      Embedded customer object for inline upsert

    • customer_external_id
      Type: string · Customer External Id nullable

      External customer ID for lookup (requires customer_source)

    • customer_id
      Type: string · Customer IdFormat: uuid nullable

      Internal customer UUID for lookup

    • customer_source
      Type: stringenum nullable

      Source namespace of the customer to look up. Must match the source value used when the customer was originally created.

      values
      • netsuite
      • priority
      • zoho_books
      • quickbooks
      • salesforce
    • customer_type_override
      Type: stringenum nullable

      Override customer type for this transaction only (retail, marketplace, wholesale, retail_exempt)

      values
      • retail
      • marketplace
      • reseller
  • document_name
    Type: string · Document Name
    max length:  
    50     nullable

    As shown in ERP systems

  • external_created_at
    Type: string · External Created AtFormat: date-time nullable

    Your system created timestamp (ISO8601 format, used for tax calculation)

  • external_updated_at
    Type: string · External Updated AtFormat: date-time nullable

    Your system updated timestamp (ISO8601 format, used for tax calculation)

  • id
    Type: string · IdFormat: uuid nullable

    Optional UUID (generated if not provided)

  • is_tax_inclusive
    Type: boolean · Is Tax Inclusive nullable

    Whether tax is embedded in prices (true) or separate (false)

  • items
    Type: array object[] | null · Items 1… nullable

    Line items in this transaction

    • unit_price
      Type: string · Unit PriceFormat: decimal
      required

      Per-item cost (can be positive or negative)

    • description
      Type: string · Description nullable

      Detailed information about the item

    • discount
      Type: string · DiscountFormat: decimal nullable

      Applied discount amount (positive number)

    • exemption_id
      Type: string · Exemption IdFormat: uuid nullable

      Reference to an exemption certificate for this item

    • exemption_reason
      Type: string · Exemption Reason
      max length:  
      256       nullable

      Reason this item is exempt from tax

    • manual_sales_tax_rate
      nullable
      • Type: number · Manual Sales Tax Rate
        min:  
        0
        max:  
        1

        Manual rate for tax calculation (if provided, overrides automatic tax calculation)

    • name
      Type: string · Name
      max length:  
      256       nullable

      Item designation or label

    • quantity
      Type: string · QuantityFormat: decimal nullable

      Number of items (positive number)

    • tax_code
      Type: string · Tax Code
      max length:  
      256       nullable

      Product tax classification

  • linked_transaction
    Type: string · Linked Transaction
    max length:  
    256     nullable

    For refunds: the external_id of the original invoice to link to. Tax rates from the original invoice date will be used.

  • override_threshold
    Type: boolean · Override Threshold

    When true, skips threshold establishment checks and forces tax calculation regardless of threshold status.

  • shipping_fee
    Type: object · ShippingFeeRequest nullable

    Shipping cost with tax configuration

    • total_price
      Type: string · Total PriceFormat: decimal
      required

      Cost amount

    • manual_sales_tax_rate
      nullable
      • Type: number · Manual Sales Tax Rate
        min:  
        0
        max:  
        1

        Manual rate for tax calculation (if provided, overrides automatic tax calculation)

    • tax_code
      Type: string · Tax Code
      max length:  
      256       nullable

      Product tax classification

  • transaction_level_discount
    Type: string · Transaction Level DiscountFormat: decimal nullable

    Discount applied to entire transaction

  • 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