Consultar documento

PUT /api/documents/{key}/v4

Este endpoint permite consultar un documento electrónico al Ministerio de Hacienda. Hace el proceso directo de siempre ir a Hacienda a consultar el estado de un documento y obtener la respuesta volver a marcar el documento con la respuesta y guardar los metadatos de la operación.

Aquí se especifica la clase de salida: CheckDocumentResponse

Parámetros

key (string)

Representa la clave del documento electrónico. Es obligatorio y forma parte del URL de la llamada al endpoint. Valor de ejemplo: 50617062500310137293502000001010000000109119079365

includeData (bool) (opcional)

Este parámetro se puede enviar por medio del query string. Su valor por defecto es false. Le indica al endpoint si debe devolver el XML firmado en base64.

Esto permite que los clientes que consumen el API pueden elegir entre obtener los XML directos en las respuestas o obtenerlos después en llamadas individuales.

includeDataResponse (bool) opcional

Este parámetro se puede enviar por medio del query string. Su valor por defecto es false. Le indica al endpoint si debe devolver el XML de respuesta en base64.

Esto permite que los clientes que consumen el API pueden elegir entre obtener los XML directos en las respuestas o obtenerlos después en llamadas individuales.

Respuestas Esperadas

HTTP 200 OK

El documento ha sido procesado exitosamente y se ha consultado al Ministerio de Hacienda. Los datos han sido almacenados y son enviados al cliente.

HTTP 500 Internal Server Error

Ocurrio un error interno o hubo un problema en la comunicación con Hacienda.

Ejemplo de respuesta con error con descripción completa:

    {
        "id_externo": "12",
        "consecutivo": "20",
        "numero_documento": "02000001040000000020",
        "clave": "50630052500310137293502000001040000000020119079365",
        "estado": "05",
        "estado_humanizado": "NotSendYet",
        "xml": "",
        "xml_respuesta": "",
        "mensaje_api": "Las respuestas que Hacienda está enviando no se pueden leer con claridad."
    }

Ejemplo

Llamada

    curl -X 'PUT' \
    'https://api44.qupos.com/api/documents/50603042300310140926100200001050000019023171187576/v4' \
    -H 'accept: text/plain' \
    -H 'AuthToken: TOKEN_UNICO' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Basic bmNxOk5DUVXXXXXXXXAwNzA1'
    }'

Respuesta

    {
        "id_externo": "50",
        "consecutivo": "24",
        "numero_documento": "02000001040000000024",
        "clave": "50606062500310137293502000001040000000024119079365",
        "estado": "01",
        "estado_humanizado": "Accepted",
        "codigo_mensaje_hacienda": "1",
        "mensaje_hacienda": "Aceptado",
        "detalle_mensaje_hacienda": [
            "1- Este comprobante fue recibido en el ambiente de pruebas, por lo cual no tiene validez para fines tributarios.",
            "2- Estimado obligado tributario los datos suministrados en provincia, cantón y distrito del 'emisor' no concuerdan con la información registrada en la Dirección General de Tributación, favor proceder actualizar sus datos."
        ],
        "xml": "",
        "xml_respuesta": "",
        "mensaje_api": ""
    }