Skip to main content

Tax Reporting Codes API

This API provides endpoints for managing tax reporting codes, which determine where tax amounts are reported on tax returns.

Get All Tax Reporting Codes​

Retrieves a list of all tax reporting codes, with options to filter by layout and activity status.

  • HTTP Method: GET
  • Path: /tax/tax-reporting-codes

Parameters​

NameTypeInDescription
tax_report_layout_idstring (uuid)queryOptional. Filters codes by a specific tax report layout ID.
active_onlybooleanqueryOptional. If true, returns only active codes. Defaults to true.

Example Request​

GET /tax/tax-reporting-codes?tax_report_layout_id=11111111-1111-1111-1111-111111111101

Example Response​

[
  {
    "id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
    "code": "VAT_SALES_STD",
    "description": "VAT on Standard Rated Sales",
    "tax_report_field": "BOX_1",
    "tax_report_layout_id": "11111111-1111-1111-1111-111111111101",
    "is_active": true,
    "created_at": "2025-10-19T10:00:00Z",
    "updated_at": null
  }
]

Get Tax Reporting Code by ID​

Retrieves a single tax reporting code by its unique identifier.

  • HTTP Method: GET
  • Path: /tax/tax-reporting-codes/{id}

Example Request​

GET /tax/tax-reporting-codes/a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6

Example Response​

{
  "id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
  "code": "VAT_SALES_STD",
  "description": "VAT on Standard Rated Sales",
  "tax_report_field": "BOX_1",
  "tax_report_layout_id": "11111111-1111-1111-1111-111111111101",
  "is_active": true,
  "created_at": "2025-10-19T10:00:00Z",
  "updated_at": null
}

Create Tax Reporting Code​

Creates a new tax reporting code.

  • HTTP Method: POST
  • Path: /tax/tax-reporting-codes

Example Request​

{
  "code": "VAT_PURCH_IMPORTS",
  "description": "VAT on Purchases from Imports",
  "tax_report_field": "BOX_9",
  "tax_report_layout_id": "11111111-1111-1111-1111-111111111101"
}

Example Response​

{
  "id": "b2c3d4e5-f6a7-8b9c-0d1e-f2a3b4c5d6e7",
  "code": "VAT_PURCH_IMPORTS",
  "description": "VAT on Purchases from Imports",
  "tax_report_field": "BOX_9",
  "tax_report_layout_id": "11111111-1111-1111-1111-111111111101",
  "is_active": true,
  "created_at": "2025-10-19T11:00:00Z",
  "updated_at": null
}

Update Tax Reporting Code​

Updates an existing tax reporting code.

  • HTTP Method: PUT
  • Path: /tax/tax-reporting-codes/{id}

Example Request​

{
  "code": "VAT_PURCH_IMPORTS_UPDATED",
  "description": "VAT on Purchases from Imports (Updated)",
  "tax_report_field": "BOX_9A",
  "tax_report_layout_id": "11111111-1111-1111-1111-111111111101"
}

Example Response​

200 OK

Delete Tax Reporting Code​

Deletes a tax reporting code.

  • HTTP Method: DELETE
  • Path: /tax/tax-reporting-codes/{id}

Example Request​

DELETE /tax/tax-reporting-codes/b2c3d4e5-f6a7-8b9c-0d1e-f2a3b4c5d6e7

Example Response​

204 No Content