The Spanish version is the authoritative reference. View in Spanish
Cancellation process
The API in Panamá offers the option to automate the document cancellation process. To do this, you must use the ChangeDocumentStatus method with the following parameters:
| ChangeDocumentStatus for cancellation (request) | |||
|---|---|---|---|
| Parameter | Type | Description | Allowed values |
| countryDocumentId | String | Country-level tax identifier of the document, also known as CUFE, CLAVE, UUID, ID | See the Country Document ID Structure table |
| Reason | String | Reason for the cancellation | Alphanumeric characters. |
| Status | String | Cancellation code: 4 | Numeric characters |
Request example
For this method we use the Params tab in Postman.
- Select the method type. In this case, you must select POST.
- Enter the method URL.
- Enter the parameters shown in the table above with their corresponding values.
- Click Send.
If the event is generated successfully, it is then sent to the Tax Authority for validation and acceptance.
Response example
Since this is a synchronous method, the response is received immediately. If the result is successful, the API will respond as follows:
To correctly interpret the response from the Tax Authority, take the following into account:
The record of this request and its acceptance message will be logged in the notes of the document preview in Inbox.
In addition, the XML of the event sent to the Tax Authority will be shown as an attachment.
On the Inbox query screen, the document will be shown with the status Cancelled.
If the result of the submission is NOT successful, the Inbox API will respond with the following error message:
{
"ErrorMessage": null,
"IsValid": false,
"StatusCode": "500",
"StatusDescription": null,
"StatusMessage": " El estado del documento no fue actualizado correctamente",
"XmlBase64Bytes": null,
"XmlBytes": null,
"XmlDocumentKey": null,
"XmlFileName": null,
"ResponseType": null,
"OtherData": null,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"Timestamp": null,
"Response": null,
"TaxDocument": null
}The record of this request and the error message will be shown in the notes of the document preview within Inbox.
If the document has been previously cancelled, the following response will be shown:
