Método para Consulta de documentos con relacionados (GetRelatedDocuments)

Si el documento que queremos cancelar tiene otros documentos relacionados, es necesario cancelar primero esos documentos relacionados antes de proceder con la cancelación del documento principal.

Para identificar los documentos vinculados, se puede utilizar el método POST GetRelatedDocuments. 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/GetRelatedDocuments

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

El método tiene los siguientes parámetros:

GetRelatedDocuments (request)
Parámetro	Tipo	Descripción	Valores permitidos
UUID*	String	Identificador fiscal del documento a nivel pais.	UUID (36 caracteres alfanuméricos)
RFCEmisor*	String	ID fiscal del emisor del documento Personas Morales: Se compone de 3 letras seguidas por 6 dígitos y 3 caracteres alfanuméricos =12 Personas Físicas: consta de 4 letras seguida por 6 dígitos y 3 caracteres alfanuméricos =13	Caracteres alfanuméricos [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.

Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization y habilitar la empresa para el consumo del mismo.

Ejemplo de respuesta

La Entidad Tributaria responde las consultas a través de la API de la siguiente forma:

Resultado Satisfactorio: Con CFDI relacionados: Lista de Hijos

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"OtherData": {
"ListaHijos": "[{\"Uuid\":\"451EF0DC-A8C9-5E09-AAC8-FF0466DE3FB7\",\"RfcEmisor\":\"ANJ235103JM8\",\"RfcReceptor\":\"PEP201306OSE\"}]"
},
"Messages": [
"WS Consulta CFDI relacionados RfcEmisor: ANJ235103JM8",
"folio físcal: 239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"Clave: 2000",
"Se encontraron CFDI relacionados"
],
"ResponseValue": null,
"Code": "2000",
"Description": "Se encontraron CFDI relacionados",
"ErrorException": null
}

Resultado Satisfactorio: Con CFDI relacionados: Lista de Padres

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "451EF0DC-A8C9-5E09-AAC8-FF0466DE3FB7",
"OtherData": {
"ListaPadres": "[{\"Uuid\":\"239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5\",\"RfcEmisor\":\"ANJ235103JM8\",\"RfcReceptor\":\"PEP201306OSE\"}]"
},
"Messages": [
"WS Consulta CFDI relacionados RfcEmisor: ANJ235103JM8",
"folio físcal: 451EF0DC-A8C9-5E09-AAC8-FF0466DE3FB7",
"Clave: 2000",
"Se encontraron CFDI relacionados"
],
"ResponseValue": null,
"Code": "2000",
"Description": "Se encontraron CFDI relacionados",
"ErrorException": null
}

Resultado Satisfactorio: Sin CFDI relacionados

{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "451EF0DC-A8C9-5E09-AAC8-FF0466DE3FB7",
"OtherData": {},
"Messages": [
"WS Consulta CFDI relacionados RfcEmisor: ANJ235103JM8",
"folio físcal: 451EF0DC-A8C9-5E09-AAC8-FF0466DE3FB7",
"Clave: 2001",
"No existen CFDI relacionados"
],
"ResponseValue": null,
"Code": "2001",
"Description": "No existen CFDI relacionados",
"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": "33331867-1765-49C2-8CC3-8E0E602CDA72",
"OtherData": null,
"Messages": [
"Documento no encontrado"
],
"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
}

Error con el certificado del cliente:

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

Error con el certificado del cliente:

{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5",
"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": "Regla: Error de Certificado, verifique el certificado y reintente nuevamente. .Cer or .Key estan vacios para el accountCode: ANJ235103JM8",
"ErrorException": null
}

Interpretar la Respuesta

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

GetRelatedDocuments (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	Listado de padres y/o hijos relacionados al documento	null {}
OtherData.ListaPadres	String	Nodo que contiene la información de el(los) uuid(s) que el documento consultado tiene como padre
OtherData.ListaPadres	String	Es el UUID Padre del documento
OtherData.ListaPadres	String	Es el RFC del emisor del documento padre
OtherData.ListaPadres	String	Es el RFC del receptor del documento padre
OtherData.ListaHijos	String	Nodo que contiene la información de el(los) uuid(s) que el documento consultado tiene como hijo
OtherData.ListaHijos	String	Es el UUID hijo del documento
OtherData.ListaHijos	String	Es el RFC del emisor del documento hijo
OtherData.ListaHijos	String	Es el RFC del receptor del documento hijo
Messages	String	Detalle de la operación realizada, datos de solicitud, estado de proceso	Ejemplo: [ "WS Consulta CFDI relacionados RfcEmisor: ANJ235103JM8". "folio físcal: 239EF8DC-A6C7-3E87-AAC6-FF8244DE1FB5". "Clave: 2000", "Se encontraron CFDI relacionados" ]
ResponseValue	String	null	null
Code	String	Código de respuesta del proceso	* 2000: Se encontraron CFDI relacionados * 2001: No existen CFDI relacionados * 2002: El folio fiscal no pertenece al receptor * 2003: La consulta supera la cantidad máxima permitida de folios fiscales * 2004: El folio fiscal no pertenece al emisor * 0: RelatedDocument - existe algun error * 404: Documento no encontrado * 500: Documento no encontrado
Description	String	Indica la descripción del codigo de respuesta del proceso	* 2000: Se encontraron CFDI relacionados * 2001: No existen CFDI relacionados * 2002: El folio fiscal no pertenece al receptor * 2003: La consulta supera la cantidad máxima permitida de folios fiscales * 2004: El folio fiscal no pertenece al emisor * 0: RelatedDocument - existe algun error * 404: Documento no encontrado * 500: Documento no encontrado
ErrorException	String	null	null

Ejemplo de petición​

Ejemplo de respuesta​

Interpretar la Respuesta​

Ejemplo de petición

Ejemplo de respuesta

Interpretar la Respuesta