DELETE TaxItems

Description

This API endpoint enables the deletion of tax items, providing the capability to remove specific tax items. Deletion operations are filtered based on externalReportingEntity and companyCode parameters, allowing targeted removal of tax items associated with specific entities and companies. It's worth noting that while this endpoint offers valuable functionality, its usage is optional and may not be mandatory for all scenarios.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/TaxItems

• Method: DELETE

Request Body

{
  "data": {
    "companyCode": "string",
    "reportingDateFrom": "string",
    "reportingDateTo": "string",
    "externalReportingEntity": "string"
  }
} `

API Contract

API allows the deletion of all tax items based on the filters passed in the request.
externalReportingEntity is a mandatory parameter in the items collection. Additionally, companyCode can be provided to filter the items that need to be deleted.
The reportingDateFrom and reportingDateTo fields are optional, if provided, the system excludes only the tax items within the range specified.
reportingDateFrom should not be be provided without the reportingDateTo as a counterpart for the range. The contrary holds true.
The date format is yyyy-mm-dd.
X-Request-ID will be used to identify the deletion request. In case of connectivity issues, the retries can be made with the same X-Request-ID.

Sample Response

HTTP 201 code is returned and empty body

Sample request [CURL]

curl --location --request DELETE 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/TaxItemsDelete' \
--header 'X-Request-Id: 4DCC0964-C600-44C6-A9E6-00042E368EFC' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token_value>' \
--data ' {
     "data" : {
         "companyCode": "AT1",
         "reportingDateFrom": "2023-08-01",
         "reportingDateTo": "2023-08-10"
     },
     "externalReportingEntity": "A000470001"
}'