Saltar al contenido principal

Método para cambiar el estado ante la Entidad Tributaria (ChangeDocumentAuthorityStatus)

Este método permite cambiar el estado de un documento ante la entidad tributaria a Anulado utilizando el servicio POST ChangeDocumentAuthorityStatus.

Por medio de este método, se puede cambiar el estado ante la entidad tributaria a un documento que tenga estado aprobado.

Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Document/ChangeDocumentAuthorityStatus
SANDBOXhttps://developers-sbx.gosocket.net/api/v1/Document/ChangeDocumentAuthorityStatus

¿Cómo funciona el método?​

Para realizar la petición, el método tiene los siguientes parámetros: 

ChangeDocumentAuthorityStatus (request)
ParámetroTipoDescripciónValores permitidos
globalDocumentIdStringIdentificación de documento en Gosocket.UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
statusStringCódigo del nuevo estado ante la entidad tributaria."Status":"4" Ya que todos los documentos sometidos a este método serán anulados.
UserNameStringUsuario que hace el requerimientoEjemplo: "nombre@gosocket.com”
reasonStringCódigo de motivo de cambio1: Factura mal emitida 2: Datos de emisión incorrectos 3: Factura o nota de crédito/débito devuelto
CountryIdStringIdentificación del paísbo

Ejemplo de petición​

image-20240502-223536.png

Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.

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.
  3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
  4. Presione Send.

Ejemplo de respuesta​

image-20240502-223844.png

Respuestas con error​

image-20240502-223956.png

image-20240502-224025.png

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

image-20240502-224110.png

Características del método ChangeDocumentAuthorityStatus​

  • El método permite cambiar el estado a anulado cuando se encuentra en un estado aprobado.

  • Algunos ejemplos de respuesta (StatusMessage) del proceso son:

    • "No es posible cambiar el estado de un documento aprobado al estado XX"
    • "El estado del documento fue actualizado correctamente"