Consultar Estado de un Documento Soporte Electrónico

Consultar Estado de un Documento Soporte Electrónico#

Este servicio permite consultar el estado actual de los documentos electrónicos transmitidos de forma asincrónica.

Para consumir la API, es importante tener en cuenta en qué entorno se trabajará. SOVOS Saphety dispone de dos ambientes, los cuales están detallados en el apartado Entornos.

Consumo del método de consulta de estado.#

estadoDocFE

El Verbo Http (acción) que se utiliza para la consulta de estado de este documento es:

GET

El método que se utiliza para la consulta de este documento es:

    /v2/{virtualOperator}/outbounddocuments/{documentId}/status

Para esta petición se requiere como parámetro el alias de su operador virtual y el código identificador único del documento emitido.

Parámetro 1 - virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parámetro 2 - DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el código identificador único del documento emitido.

Respuesta#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Status": "Certified",
        "ValidationErrors": null
    },
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

status: 200 OK

Cuando el servicio responde con un código 200, significa que la consulta fue exitosa. Para conocer el estado actual del documento, debes revisar el campo Status dentro del mensaje de respuesta, que indica en qué situación se encuentra el documento electrónico.

resultFE

status: 400 Bad Request

Si recibes un código 400, indica que hubo un error en la solicitud. Para conocer las causas específicas del rechazo o error, debes revisar la sección ResultData dentro del mensaje de respuesta, donde se detallan las causales de rechazo asociadas al documento consultado.

resultFE

Referencia: Swagger#

Para obtener más información, puedes consultar la documentación del API de SOVOS Saphety en Swagger. A continuación, se indican los enlaces según el ambiente: