Método para Consulta de documentos pendientes de cancelación (GetPendingCancelRequest)

Cuando el CFDI requiere la aceptación para ser cancelado, la API permite verificar si el receptor tiene documentos pendientes de cancelación.

Para identificar los documentos con solicitud pendiente de cancelación, se puede utilizar el método POST GetPendingCancelRequest.

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/GetPendingCancelRequest

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

El método tiene los siguientes parámetros:

GetPendingCancelRequest (request)
Parámetro	Tipo	Descripción	Valores permitidos
RFCReceptor*	String	ID fiscal del receptor 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.

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.

{
"RFCReceptor":"ANJ235103JM8"
}

4. Presione Send.

---

Ejemplo de respuesta

La Entidad Tributaria responde las consultas a través de la API de la siguiente forma: Resultado Satisfactorio: No existen peticiones pendientes para el RFC consultado

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": {},
"Messages": [
"0"
],
"ResponseValue": null,
"Code": "1101",
"Description": "No existen peticiones para el RFC Receptor",
"ErrorException": null
}

Resultado Satisfactorio: Con peticiones pendientes

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": {
"Uuids": "{\"Uuid\":[\"239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5\"]}"
},
"Messages": [
"0"
],
"ResponseValue": null,
"Code": "1100",
"Description": "Se obtuvieron las peticiones del RFC Receptor de forma exitosa",
"ErrorException": null
}

Si el resultado del envío NO es satisfactorio, la API de Inbox responderá con un mensaje de error: 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
}

Error con el certificado del cliente:

{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": null,
"Messages": [
"Regla: Error de Certificado, verifique el certificado y reintente nuevamente. Failed to load certificate after retries"
],
"ResponseValue": null,
"Code": "500",
"Description": null,
"ErrorException": null
}

Error con el certificado del cliente:

{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": null,
"Messages": [
"Regla: Error de Certificado, verifique el certificado y reintente nuevamente. .Cer or .Key estan vacios para el accountCode: ANJ235103JM8"
],
"ResponseValue": null,
"Code": "500",
"Description": null,
"ErrorException": null
}

Interpretar la Respuesta

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

GetPendingCancelRequest (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	null	null
OtherData	String	Listado de documentos con solicitud pendiente de cancelación.	null o un objeto con la propiedad Uuids.
OtherData.Uuids	String	Nodo que contiene la información del/de los UUID con solicitud pendiente de cancelación.	Ejemplo: {"Uuid":["239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5"]}
Messages	String	Código global de la invocación. Un valor de 0 (cero) indica que la invocación se dio exitosamente, o de otra forma se indica la razón del problema.	Ejemplo: "0"
ResponseValue	String	null	null
Code	String	Código de respuesta del proceso	* 1100: Se obtuvieron las peticiones del RFC Receptor de forma exitosa * 1101: No existen peticiones para el RFC Receptor
Description	String	Indica la descripción del codigo de respuesta del proceso	* 1100: Se obtuvieron las peticiones del RFC Receptor de forma exitosa * 1101: No existen peticiones para el RFC Receptor
ErrorException	String	null	null