;

¿Cómo funciona el Método ChangeDocumentStatus?

Modificado el Jue, 26 Sep, 2024 a 3:10 P. M.

Cada país tiene una forma diferente de utilizar este método. A continuación, explicaremos el método y su funcionamiento en cada país. 


  • Colombia


Por medio de este método, se puede informar cada uno de los estados mercantiles o estados RADIAN de un documento (Acuse, Recibo, Reclamo, Aceptación, etc). 


Para realizar la petición en la API, deberá ingresar los siguientes parámetros:

* Requerido


Los eventos mercantiles se identifican de la siguiente forma: 


Los eventos RADIAN se identifican de la siguiente forma: 

 

Ejemplo de Petición

Para este método utilizamos la pestaña Params de Postman.


1. Seleccione el tipo de método. En este caso, se debe seleccionar POST. 


2. Ingrese la URL del Método para informar eventos en los documentos - ChangeDocumentStatus


3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes. 


4. Presione Send.


Json Ejemplo de Respuesta


Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes criterios: 



Importante: Podrá consultar los diferentes escenarios en los que puede utilizar este método consulte el Manual API Español Pag. 71 - 86.


  • Paraguay - Panamá


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 de la siguiente forma:


        1.  Agregar los parámetros: 


Ejemplo de Petición

Para este método utilizamos la pestaña Params de Postman. 


1. Seleccione el tipo de método. En este caso, se debe seleccionar POST. 


2. Ingrese la URL del Método para informar eventos en los documentos - ChangeDocumentStatus 


3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes. 


4. Presione Send. 


Si el evento se genera satisfactoriamente, entonces se envía a la Entidad Tributaria para su validación y aceptación.


En Panamá al tratarse de un método síncrono, la respuesta es recibida inmediatamente. En caso de que el resultado sea satisfactorio, la API responderá de la siguiente forma: 



Para interpretar correctamente la respuesta de la Entidad Tributaria, tome en cuenta lo siguiente: 



Este método también se utiliza para generar 5 eventos relacionados en documentos recibidos:



En Paraguay la Entidad Tributaria responde a través de la API de la siguiente forma:



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:



Importante: Para conocer el detalle de evento conformidad, evento disconformidad, evento desconocimiento, evento nominación consulte el Manual API Español Pag. 94 - 107.


Inutilización de Folios: Paraguay


Mediante este evento podrá informar a la Entidad Tributaria que no utilizó o utilizará un folio o rango de folios. 


        1. Los parámetros para mandar en la API son los siguientes:  



Ejemplo de Petición API

Para este método utilizamos la pestaña body en su sección x-ww-formurlencoded de Postman.


1. Seleccione el tipo de método. En este caso, se debe seleccionar POST. 


2. Ingrese la URL del Método para informar eventos en los documentos - ChangeDocumentStatus  


3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes. 


4. Presione Send.


Nota: Puede inutilizar máximo mil números del DE. Utilice ceros para completar los números de inicio y fin del rango

 

        2. Envío a la Entidad Tributaria: Si el evento fue generado satisfactoriamente, se envía a la Entidad Tributaria para su validación y aceptación. 


        3. Respuesta de la Entidad Tributaria: La estructura de la respuesta es la siguiente:



Ejemplo de respuesta


En caso de que el resultado sea satisfactorio, la respuesta de la API es la siguiente:



En caso de que el resultado del envío no sea satisfactorio, la API responderá con el siguiente mensaje de error:



En caso de que no se enviará el parámetro dNumFin, la API responderá de la siguiente forma: 


"Success": false, 

"GlobalDocumentId": "00000000-0000-0000-0000-000000000000", 

"CountryDocumentId": null, 

"OtherData": { 

"Country": "py", 

"Certifier": "SIFEN", 

"AuthorityTimeStamp": "26/04/2023 23:44:32"

 }, 

"Messages": [ 

“Regla: Error validando esquema del documento, verifique los campos de xml y reintente nuevamente”, 

“Error Message: The ‘http://ekuatia.set.gov.py//sifen/xsd:dNumfin’ element is invalid – The value ‘’ is invalid according to its datatype ‘http://ekuatia.set.gov.py/sifen/xsd:tdNumDE – The Pattern constraint failed.”

 ], 

"ResponseValue": null, 

"Code": "77", 

"Description": "Regla: Validando esquema del documento Archivo", 

"ErrorException": null 

}


Uruguay: Aceptación y rechazo de Documentos


A través del método ChangeDocumentStatus, también podemos emitir acuses sobre los documentos recibidos de aceptación o rechazo a través de la API. Veamos cómo emitir estos eventos.


 Los parámetros de solicitud para emitir estos eventos son los siguientes:

Requerido



Ejemplo de Petición

Para este método utilizamos la pestaña Body, seleccionamos raw y verificamos o seleccionamos JSON de Postman.


1. Seleccione el tipo de método. En este caso, se debe seleccionar POST. 


2. Ingrese la URL del Método para informar eventos en los documentos - ChangeDocumentStatus  


3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes. 


4. Presione Send.



Ejemplo de respuesta


Una vez que el acuse fue generado, se muestran los siguientes elementos dentro de la vista previa del documento que puede consultar desde el Inbox de Gosocket:



En la sección de notas de la vista previa encontraremos: 


1. Generación del evento con el usuario que lo generó. 

2. Evento mercantil generado que puede ser aceptación o rechazo. 

3. Lista de direcciones electrónicas a las que se envió el correo, o Nota con el error de porque razón no se pudo enviar el correo. 


Además, dentro de la sección de Adjuntos, vemos lo siguiente: 


1. XML del evento generado sobre el documento.


 Desde la pantalla de consulta de documentos recibidos dentro del Inbox, se muestra el ícono de aceptación o rechazo dentro de los estados de la pantalla de consulta de Recibidos.  Aceptación Rechazo


Características:


• Sólo se permite generar acuse a los documentos aprobados ante la ET (AuthorityStatus=2) 


• Sólo se permite generar acuse a los documentos cuando la fecha de emisión del documento no supere los 20 días calendario a la fecha actual. 


• El evento se envía con el xml del acuse adjunto a través de un correo electrónico. 


• El acuse NO se envía a la Entidad Tributaria.


¿Le ha sido útil este artículo?

¡Qué bien!

Gracias por sus comentarios

¡Sentimos mucho no haber sido de ayuda!

Gracias por sus comentarios

¡Háganos saber cómo podemos mejorar este artículo!

Seleccione al menos una de las razones
Se requiere la verificación del CAPTCHA.

Sus comentarios se han enviado

Agradecemos su esfuerzo e intentaremos corregir el artículo