Create Platform Transaction

Changed on Nov 3, 2026

Record completed sales from a platform calculation. For payment processors, this creates two transactions: one for the order and one for the fee. For marketplace providers or merchants of record, only the order transaction is created.

post/tax/platform/transactions

Request

Base URL
https://api.numeralhq.com
URL
https://api.numeralhq.com/tax/platform/transactions
Auth
HTTP bearer

Headers

X-API-Version'2026-03-01' required

Request body

platform_calculation_idstring required

The ID of the platform calculation to convert to transactions

reference_order_idstring required

Your unique identifier for this order

reference_payment_idstring

Your unique identifier for the payment (optional)

transaction_processed_atnumber

Unix timestamp when the transaction was processed

Response

Platform transaction list response

objectstring

Example response

{
  "object": "list",
  "transactions": [
    {
      "object": "tax.transaction",
      "line_items": [
        {
          "line_item_id": "li_1783369661107e97b4af5-b61a-487d-aa31-ecee6e616f7f",
          "product": {
            "reference_product_name": "Red Shoes",
            "reference_line_item_id": "line_123456789",
            "reference_product_id": "p-1233543",
            "product_tax_code": "GENERAL_MERCHANDISE"
          },
          "tax_jurisdictions": [
            {
              "tax_rate": 0.07,
              "tax_due_decimal": 724.9275,
              "rate_type": "GENERAL STATE SALES TAX",
              "tax_authority_name": "Tennessee",
              "tax_type": "SALES"
            }
          ],
          "quantity": 2,
          "tax_amount": 14,
          "amount_excluding_tax": 200,
          "amount_including_tax": 214
        }
      ]
    }
  ]
}

Changes

Nov 3, 2026f4650eaed11f Revision changes
- breaking
  removed the enum value 2026-01-01 from the header request parameter X-API-Version
- breaking
  the //// response's property format changed from int32 to no format for status
- breaking
  the //// response's property format changed from int32 to no format for status
- breaking
  the //// response's property format changed from int32 to no format for status
- breaking
  the //// response's property format changed from int32 to no format for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id createPlatformTransaction_v20260101 removed and replaced with createPlatformTransaction_v20260301
- info
  added the new enum value 2026-03-01 to the header request parameter X-API-Version
- info
  added the optional property //// to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history