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ámetro	Tipo	Descripción	Valores permitidos
globalDocumentId	String	Identificación de documento en Gosocket.	UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
status	String	Código del nuevo estado ante la entidad tributaria.	"Status":"4" Ya que todos los documentos sometidos a este método serán anulados.
UserName	String	Usuario que hace el requerimiento	Ejemplo: "nombre@gosocket.com”
reason	String	Código de motivo de cambio	1: Factura mal emitida 2: Datos de emisión incorrectos 3: Factura o nota de crédito/débito devuelto
CountryId	String	Identificación del país	bo

Ejemplo de petición

Datos ficticios

Los identificadores y el correo de usuario de estos ejemplos son ficticios; reemplácelos por los datos reales de su empresa.

POST https://developers-sbx.gosocket.net/api/v1/Document/ChangeDocumentAuthorityStatus?globalDocumentId=00000000-0000-0000-0000-000000000001&status=04&UserName=contacto@empresa-ejemplo.com&reason=1&CountryId=bo

Los parámetros de query enviados en la petición son:

Key	Value
globalDocumentId	00000000-0000-0000-0000-000000000001
status	04
UserName	contacto@empresa-ejemplo.com
reason	1
CountryId	bo

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.

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.

Ejemplo de respuesta

{
  "ErrorMessage": [],
  "IsValid": true,
  "StatusCode": "200",
  "StatusDescription": "",
  "StatusMessage": "El estado del documento fue actualizado correctamente",
  "XmlBase64Bytes": null,
  "XmlBytes": null,
  "XmlDocumentKey": null,
  "XmlFileName": null,
  "ResponseType": null,
  "OtherData": null,
  "GlobalDocumentId": "00000000-0000-0000-0000-000000000001",
  "Timestamp": null,
  "Response": ":\n \"facturaBoletoAereoAnulacionLote\":true\r\n",
  "TaxDocument": null
}

Respuestas con error

{
  "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
}

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

ChangeDocumentAuthorityStatus (response)
Parámetro	Tipo	Descripción	Valores permitidos
ErrorMessage	String	Descripción del mensaje de error
IsValid	Boolean	Indica si la petición se ejecutó correctamente.	true: La petición se ejecutó correctamente. false: La petición se ejecutó con alguna inconsistencia.
StatusCode	String	Código de respuesta del proceso	Ejemplos: 500: Se presentó alguna inconsistencia 200: Funcionó correctamente
StatusDescription	String	Descripción técnica del error presentado en el proceso
StatusMessage	String	Descripción de la respuesta del proceso realizado
XmlBase64Bytes, XmlBytes, XmlDocumentKey, XmlFileName, ResponseType, OtherData, GlobalDocumentId, Timestamp, Response, TaxDocument	String	Datos adicionales en la respuesta del proceso	Null o vacío

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"