Get tax table with rates and values (by tax rate)

Resolves the tax table from a tax rate id (embedded taxRates.taxRate on the table, or taxTableId on the rate when present). Returns that table, tax rate documents referenced on the table plus the anchor rate, and all tax rate values for those rates, scoped to the API key company.

get/v1/workflows/tax/by-tax-rate/{taxRateId}

Request

Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
URL: https://api.finalpos.com/v1/workflows/tax/by-tax-rate/{taxRateId}
Auth: API key in header x-api-key

Path parameters

taxRateIdstring required

Tax rate ID

Response

Returns the tax table, tax rates resolved from the table embedded taxRates refs, and tax rate values for those rates. Empty arrays when there are no matching rate/value rows.

Example response

{
  "taxTable": {
    "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "createdAt": "2025-12-07T19:31:48.436+00:00",
    "updatedAt": "2025-12-07T19:35:48.436+00:00",
    "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "source": "woo-commerce",
    "externalId": "5",
    "name": "Default Tax Table",
    "slug": "default-tax-table",
    "taxRates": [
      {
        "compounding": false,
        "taxRate": "507f1f77bcf86cd799439011"
      }
    ],
    "isStandard": true
  },
  "taxRates": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "name": "Standard Rate",
      "externalId": "12",
      "source": "quickbooks"
    }
  ],
  "taxRateValues": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "taxRateId": "507f1f77bcf86cd799439011",
      "outletId": "507f1f77bcf86cd799439012",
      "value": 8.875
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.