Mensajes de error

A continuación se detallan algunos errores que se generan al interactuar con el API. Estos errores se obtendrán en la mayoria de los casos en respuestas HTTP 500, ya son errores de contexto inesperados que impiden cumplir con la solicitud. Estos mensajes de error pueden recibirse al enviar recepciones o al enviar documentos, o incluso consultando ambos.

Las respuestas de los API tienen dos propiedades:

• mensaje_api: explicación breve del error.
• mensaje_api_key: llave técnica (programming key) que permite a los desarrolladores identificar el error.

Programming Keys

ErrorParsingXmlInput

Cuando el XML recibido en una recepción no se puede parsear correctamente.

RequestDocumentStatusError

Ocurrio un error en el proceso de intentar consultar un documento. Se debe revisar el mensaje_api_key para obtener más detalles.

{
    "id_externo": "12334",
    "consecutivo": "9",
    "numero_documento": "00200001100000000009",
    "clave": "50619082500310137293500200001100000000009113875147",
    "estado": "04",
    "estado_humanizado": "Sent",
    "codigo_mensaje_hacienda": "",
    "mensaje_hacienda": "",
    "detalle_mensaje_hacienda": [],
    "xml": "",
    "xml_respuesta": "",
    "mensaje_api": "El servidor de Hacienda no responde.",
    "mensaje_api_key": "RequestDocumentStatusError"
}

SendingDocumentError

Ocurrio un error en el proceso de intentar enviar el documento. Se debe revisar el mensaje_api_key para obtener más detalles.

TokenRetrieveError

Ocurrio un error al obtener el token para la comunicación con Hacienda. Se debe revisar el mensaje_api_key para obtener más detalles.

{
    "id_externo": "50",
    "consecutivo": "272",
    "numero_documento": "02000001010000000272",
    "clave": "50605082500310137293502000001010000000272119079365",
    "estado": "05",
    "estado_humanizado": "NotSendYet",
    "xml": "",
    "mensaje_api": "El servidor de Hacienda no responde.",
    "mensaje_api_key": "TokenRetrieveError"
}

KeyAlreadyCreated

El documento ya fue recibido para envío. Esto es cuando se recibe una solicitud para procesar un documento que ya se encuentra procesado. La respuesta a está situacion es un HTTP OK (200), se hace así para que los sistemas integradores puedan tener un bypass y no marquen con error un documento ya procesado.

ExpiredClientCertificate

El certificado se encuentra vencido, debe generar un nuevo certificado. Este es un error de configuración que requiere la atención del departamento de servicio al cliente y del propio cliente para solucionar el inconveniente con el certificado.

{
    "id_externo": "50",
    "consecutivo": "259",
    "numero_documento": "02000001010000000259",
    "clave": "50601082500310137293502000001010000000259119079365",
    "estado": "00",
    "estado_humanizado": "Pending",
    "xml": "",
    "mensaje_api": "El certificado se encuentra vencido, debe generar un nuevo certificado.",
    "mensaje_api_key": "ExpiredClientCertificate"
}

ErrorParsingHaciendaResponse

Las respuestas que Hacienda está enviando no se pueden leer con claridad. Son anómalas.

InvalidCredentials

Las credenciales de Hacienda utilizadas no son correctas. Este es un error de configuración que requiere la atención del departamento de servicio al cliente y del propio cliente para solucionar el inconveniente porque las credenciales asociadas a la compañia no son correctas. Ejemplo:

{
    "id_externo": "487",
    "consecutivo": "261",
    "numero_documento": "02000001010000000261",
    "clave": "50605082500310137293502000001010000000261119079365",
    "estado": "05",
    "estado_humanizado": "NotSendYet",
    "xml": "",
    "mensaje_api": "Las credenciales de Hacienda utilizadas no son correctas.",
    "mensaje_api_key": "InvalidCredentials"
}

Submensajes de error

Existen errores que pueden venir dentro de los errores principales de arriba, estos errores no se devuelven como llaves técnicas pero si con descripciones cortas. Para interpretar correctamente como marcar estos errores en sus sistemas, por favor respaldarse en la propiedad “estado” (por ejemplo: No enviado). No es necesario interpretar estos errores, se pueden guardar las descripciones para mostrarlas a los clientes como justificación.

HaciendaServerMaybeDown

El servidor de Hacienda no responde. Esto significa que se recibio un 503 (ServiceUnavailable) o un 502 (BadGateway) en la llamada a Hacienda, lo que indica un problema en sus sistemas. A veces tambien el HTTP REQUEST no se puede completar y se interpreta tambien como una caída en los sistemas de Hacienda.

HaciendaWeirdError

Ocurrió un error al momento de comunicación con Hacienda. Esto significa que la llamada si se realizó pero hay un HTTP Code response no predecible.

ErrorParsingHaciendaResponse

Las respuestas que Hacienda está enviando no se pueden leer con claridad. Son anómalas.