Método para Consultar el estatus del documento y de la Cancelación (GetStatusDocument)

Para cancelar un documento, es fundamental conocer su estado, ya que esto permite saber si ya ha sido cancelado o si requiere aceptación para poder cancelarlo. Por esta razón, es crucial que el API exponga tanto la consulta del estado del documento como el proceso de cancelación.

El método POST GetStatusDocument permite verificar el estado del documento y determinar en qué etapa del proceso de cancelación se encuentra.

Para hacer uso de este método, ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Document/GetStatusDocument

SANDBOXhttps://developers-sbx.gosocket.net/api/v1/Document/GetStatusDocument

El método tiene los siguientes parámetros:

GetStatusDocument (request)
Parámetro	Tipo	Descripción	Valores permitidos
UUID*	String	Identificador fiscal del documento a nivel país.	UUID (36 caracteres alfanuméricos)
RFCEmisor*	String	ID fiscal del emisor del documento. Personas Morales: 3 letras, 6 dígitos y 3 caracteres alfanuméricos (12). Personas Físicas: 4 letras, 6 dígitos y 3 caracteres alfanuméricos (13).	Caracteres alfanuméricos. Formato esperado: `[A-Z&Ñ]{3,4}[0-9]2(0[1-9]

Obligatorio

Ejemplo de petición

Para este método utilizamos la pestaña Body 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.

{
"UUID":"00000000-0000-0000-0000-000000000000",
"RFCEmisor":"ANJ235103JM8"
}

Presione Send.

Ejemplo de respuesta

La Entidad Tributaria responde las consultas a través de la API de la siguiente forma: Resultado Satisfactorio: Comprobante obtenido satisfactoriamente: Vigente - No cancelable

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "",
"ValidacionEFOS": "200",
"ResponseSAT": "PHExOkVudmVsb...udmVsb3BlPg==",
"StatusCode": "No cancelable",
"StatusMessage": "Vigente"
},
"Messages": null,
"ResponseValue": "PD94bWwgdmV...HJvYmFudGU+",
"Code": "200",
"Description": "S - Comprobante obtenido satisfactoriamente.",
"ErrorException": null
}

Resultado Satisfactorio: Comprobante obtenido satisfactoriamente: Vigente - Cancelable sin aceptación

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "",
"ValidacionEFOS": "200",
"ResponseSAT": "PHExOkVudmV...pFbnZlbG9wZT4=",
"StatusCode": "Cancelable sin aceptación",
"StatusMessage": "Vigente"
},
"Messages": null,
"ResponseValue": "PD94bWwgdm...m9iYW50ZT4=",
"Code": "200",
"Description": "S - Comprobante obtenido satisfactoriamente.",
"ErrorException": null
}

Resultado Satisfactorio: Comprobante obtenido satisfactoriamente: Vigente - Cancelable con aceptación

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "",
"ValidacionEFOS": "200",
"ResponseSAT": "PHExOkVudm...ZlbG9wZT4=",
"StatusCode": "Cancelable con aceptación",
"StatusMessage": "Vigente"
},
"Messages": null,
"ResponseValue": "PGNmZGk6Q2...wcm9iYW50ZT4=",
"Code": "200",
"Description": "S - Comprobante obtenido satisfactoriamente.",
"ErrorException": null
}

Resultado Satisfactorio: Comprobante obtenido satisfactoriamente: Cancelado - Cancelado sin aceptación

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "Cancelado sin aceptación",
"ValidacionEFOS": "200",
"ResponseSAT": "PHExOkVudmVs...ZWxvcGU+",
"StatusCode": "Cancelable sin aceptación",
"StatusMessage": "Cancelado"
},
"Messages": null,
"ResponseValue": "PD94bWwg...b2JhbnRlPg==",
"Code": "200",
"Description": "S - Comprobante obtenido satisfactoriamente.",
"ErrorException": null
}

Resultado Satisfactorio: Comprobante obtenido satisfactoriamente: Cancelado - Plazo vencido

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "Plazo vencido",
"ValidacionEFOS": "200",
"ResponseSAT": "PHExOkVu...2ZWxvcGU+",
"StatusCode": "Cancelable con aceptación",
"StatusMessage": "Cancelado"
},
"Messages": null,
"ResponseValue": "PD94bWw...JvYmFudGU+",
"Code": "200",
"Description": "S - Comprobante obtenido satisfactoriamente.",
"ErrorException": null
}

Resultado Satisfactorio: Comprobante no encontrado: No encontrado

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"EstatusCancelacion": "",
"ValidacionEFOS": "",
"ResponseSAT": "PHExOkVudm...nZlbG9wZT4=",
"StatusCode": "",
"StatusMessage": "No Encontrado"
},
"Messages": null,
"ResponseValue": "PD94bWwg...9iYW50ZT4=",
"Code": "99",
"Description": "N - 602: Comprobante no encontrado.",
"ErrorException": null
}

Si el resultado del envío NO es satisfactorio, la API de Inbox responderá con un mensaje de error: Documento no encontrado en la base de datos:

{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": {
"StatusCode": "500",
"StatusMessage": null
},
"Messages": null,
"ResponseValue": null,
"Code": "500",
"Description": "Documento no encontrado",
"ErrorException": null
}

Empresa no activa para consumir el método:

{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": null,
"Messages": null,
"ResponseValue": "Permis Required",
"Code": "500",
"Description": "Empresa no activa para utilizar el evento CancelFunction",
"ErrorException": null
}

Interpretar la Respuesta

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

GetStatusDocument (response)
Parámetro	Tipo	Descripción	Valores permitidos
Success	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.
GlobalDocumentId	String	null	00000000-0000-0000-0000-000000000000
CountryDocumentId	String	Identificador fiscal del documento (UUID) consultado.	null UUID consultado (36 caracteres alfanuméricos).
OtherData	String	Propiedades adicionales de acuerdo con el país y el método.
OtherData.EstatusCancelacion	String	Estado de la solicitud de cancelación	* En proceso * Cancelado sin aceptación * Cancelado con aceptación * Solicitud Rechazada * Plazo Vencido * null
OtherData.ValidacionEFOS	String	Estado del contribuyente emisor en la lista EFOS	* 100 * 200
OtherData.ResponseSAT	String	XML con la respuesta de la SAT para el documento consultado	XML codificado en base 64
OtherData.StatusCode	String	Condiciones de cancelación	* Cancelable sin aceptación * Cancelable con aceptación * No cancelable
OtherData.StatusMessage	String	Estatus del Comprobante	* Vigente * Cancelado * No encontrado
Messages	String	null	null
ResponseValue	String	Respuesta del servicio consultado en formato XML codificada en base 64.	XML codificado en base 64
Code	String	Código de respuesta del proceso	* 99: Comprobante no encontrado * 200: Comprobante obtenido satisfactoriamente * 404: documento no encontrado en Inbox
Description	String	Indica si el comprobante fue encontrado si hay un problema en la consulta	* N 601: La expresión impresa proporcionada no es válida. * N 602: Comprobante no encontrado * S Comprobante obtenido satisfactoriamente
ErrorException	String	null	null

Ejemplo de petición​

Ejemplo de respuesta​

Interpretar la Respuesta​

Ejemplo de petición

Ejemplo de respuesta

Interpretar la Respuesta