Cancelación de documentos
La API en Paraguay y Panamá ofrece la opción de automatizar el proceso de cancelación de documentos. Para hacer esto, es necesario utilizar método ChangeDocumentStatus con los siguientes parámetros:
| ChangeDocumentStatus para cancelación (request) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| countryDocumentId | String | Identificador fiscal del documento a nivel país, conocido también como CUFE, CLAVE, UUID, ID | Ver tabla Estructura Country Document ID |
| Description | String | Razón de la cancelación | Caracteres alfanuméricos. |
| Status | String | Código de cancelación: 4 | Caracteres numéricos |
Ejemplo de petición
POST https://developers.gosocket.net/sandbox/api/v1/Document/ChangeDocumentStatus
?countryDocumentId=FE0000000000000000-2-2021-0000000000000000
&Reason=Documento cancelado por monto incorrecto.
&Status=4
Los identificadores de los ejemplos de esta página son ficticios.
Para este método utilizamos la pestaña Params de Postman.
- Seleccione el tipo de método. En este caso, se debe seleccionar POST.
- Ingrese la URL del método.
- Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
- Presione Send.
Si el evento se genera satisfactoriamente, entonces se envía a la Entidad Tributaria para su validación y aceptación.
Ejemplo de respuesta
La Entidad Tributaria responde a través de la API de la siguiente forma.
{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "01800000000000000000000000000000000000000000",
"OtherData": {
"Country": "py",
"Certifier": "SIFEN",
"AuthorityTimeStamp": "19/09/2023 16:57:00"
},
"Messages": [],
"ResponseValue": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...",
"Code": "0600",
"Description": "Evento registrado correctamente, Evento Cancelación",
"ErrorException": null
}Nota: el valor de ResponseValue se muestra truncado; corresponde a la respuesta de la entidad codificada en base 64.
El registro de esta solicitud y su mensaje de aceptación quedarán registrados en las notas de la vista previa del documento en Inbox.
Además, se mostrará adjunto el XML del evento enviado a la Entidad Tributaria.
En la pantalla de consulta de Inbox, el documento se mostrará con el estado Anulado.
Si el resultado del envío NO es satisfactorio, la API de Inbox responderá con el siguiente mensaje de error:
{
"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
}El registro de esta solicitud y el mensaje de error se mostrará en las notas de la vista previa del documento dentro de Inbox.
En caso de que el documento haya sido previamente cancelado, se mostrará la siguiente respuesta:
{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": null,
"Messages": [
"Regla: Evento no puede ser registrado ya que el documento no se encuentra en estado aprobado."
],
"ResponseValue": null,
"Code": "400",
"Description": "Evento no puede ser registrado ya que el documento no se encuentra en estado aprobado.",
"ErrorException": null
}