Consulta del Estado de un Documento Equivalente Electrónico

Consulta del Estado de un Documento Equivalente 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 considerar el entorno en el que se trabajará. SOVOS Saphety dispone de dos ambientes, los cuales se describen en el apartado de 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

Para identificar el estado en el que se encuentra el documento, revise el campo Status en el mensaje de respuesta.

resultFE

status: 400 Bad Request

Para identificar las causales de rechazo, revise la sección ResultData en el mensaje de respuesta.

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: