Calculation batches · GET

Retrieve a sales tax calculation batch

Returns the batch status and the results available so far.

GET/v1/calculation-batches/{batch_id}

Parameters

Send these headers and path or query values with the request.

Name	Type	Required	Description
`Authorization`	`string`	Yes	Send your API key as a bearer token.
`batch_id`	`string`	Yes
`expand`	`string`	No	Set to audit for an authorized customer-safe audit expansion.

Responses

200

The batch.

Headers: Request-Id, Retry-After

401

A valid API key is required.

Headers: WWW-Authenticate

403

The authenticated key cannot perform this operation.

404

The resource does not exist in the authenticated workspace.

429

The request exceeded an API safety limit. It did not count toward API usage.

Headers: Retry-After

503

A required service is unavailable, so the API could not process the request.

Headers: Retry-After

Live request

Try this endpoint

api.salestaxcalculatorapi.com

The browser sends the request straight to the API. Your API key never passes through this website's server.

API keybatch_id · requiredexpand

Request

Shell

curl --request GET \
  --url "https://api.salestaxcalculatorapi.com/v1/calculation-batches/batch_01J6A6X3DWHGCY7G2XXEXAMPLE" \
  --header "Authorization: Bearer $SALESTAX_API_KEY"

200 responseJSON

{
  "id": "batch_01J6A6X3DWHGCY7G2XXE5MPA2R",
  "object": "calculation_batch",
  "reference": "erp-import-2026-08",
  "status": "partially_failed",
  "total_count": 2,
  "succeeded_count": 1,
  "failed_count": 1,
  "items": [
    {
      "index": 0,
      "status": "succeeded",
      "calculation": {
        "id": "calc_01J6A3S8Z6K4M6T2Y2W9M5X8Q0",
        "object": "calculation",
        "reference": "order-1001",
        "outcome": "calculated",
        "currency": "CAD",
        "subtotal": "100.00",
        "taxable_amount": "100.00",
        "tax": "13.00",
        "total": "113.00",
        "lines": [
          {
            "id": "line_01J6A3T26X8BS4Y8XJKZ0H8F3P",
            "reference": "subscription",
            "outcome": "calculated",
            "subtotal": "100.00",
            "taxable_amount": "100.00",
            "tax": "13.00",
            "total": "113.00",
            "explanation": "Tax was calculated for this sale."
          }
        ],
        "explanation": "Tax was calculated for this sale.",
        "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9",
        "created_at": "2026-08-29T12:00:00Z"
      }
    },
    {
      "index": 1,
      "status": "failed",
      "problem": {
        "type": "https://api.salestaxcalculatorapi.com/problems/invalid_request",
        "title": "Invalid request",
        "status": 400,
        "detail": "The amount field is invalid.",
        "instance": "/v1/calculation-batches/batch_01J6A6X3DWHGCY7G2XXE5MPA2R",
        "code": "invalid_request",
        "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9",
        "retryable": false,
        "errors": [
          {
            "pointer": "/lines/0/amount",
            "message": "Use a decimal string with the currency scale."
          }
        ]
      }
    }
  ],
  "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9",
  "created_at": "2026-08-29T12:01:00Z",
  "completed_at": "2026-08-29T12:02:00Z"
}

Name

Type

Required

Description

Authorization

string

Yes

Send your API key as a bearer token.

batch_id

string

Yes

expand

string

Set to audit for an authorized customer-safe audit expansion.

Responses

200

The batch.

Headers: Request-Id, Retry-After

401

A valid API key is required.

Headers: WWW-Authenticate

403

The authenticated key cannot perform this operation.

404

The resource does not exist in the authenticated workspace.

429

The request exceeded an API safety limit. It did not count toward API usage.

Headers: Retry-After

503

A required service is unavailable, so the API could not process the request.

Headers: Retry-After

{ "id": "batch_01J6A6X3DWHGCY7G2XXE5MPA2R", "object": "calculation_batch", "reference": "erp-import-2026-08", "status": "partially_failed", "total_count": 2, "succeeded_count": 1, "failed_count": 1, "items": [ { "index": 0, "status": "succeeded", "calculation": { "id": "calc_01J6A3S8Z6K4M6T2Y2W9M5X8Q0", "object": "calculation", "reference": "order-1001", "outcome": "calculated", "currency": "CAD", "subtotal": "100.00", "taxable_amount": "100.00", "tax": "13.00", "total": "113.00", "lines": [ { "id": "line_01J6A3T26X8BS4Y8XJKZ0H8F3P", "reference": "subscription", "outcome": "calculated", "subtotal": "100.00", "taxable_amount": "100.00", "tax": "13.00", "total": "113.00", "explanation": "Tax was calculated for this sale." } ], "explanation": "Tax was calculated for this sale.", "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9", "created_at": "2026-08-29T12:00:00Z" } }, { "index": 1, "status": "failed", "problem": { "type": "https://api.salestaxcalculatorapi.com/problems/invalid_request", "title": "Invalid request", "status": 400, "detail": "The amount field is invalid.", "instance": "/v1/calculation-batches/batch_01J6A6X3DWHGCY7G2XXE5MPA2R", "code": "invalid_request", "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9", "retryable": false, "errors": [ { "pointer": "/lines/0/amount", "message": "Use a decimal string with the currency scale." } ] } } ], "request_id": "req_01J6A3RZ1HT2K3W2X8R7P1J4C9", "created_at": "2026-08-29T12:01:00Z", "completed_at": "2026-08-29T12:02:00Z" }