Consultar Estado de un Documento de Facturación Electrónica

Consultar Estado de un Documento de Facturación Electrónica#

Este servicio permite consultar el estado actual de los documentos electrónicos (facturas, notas crédito o notas débito) que han sido transmitidos asincrónicamente a la DIAN.

A través de esta consulta, es posible obtener información sobre el resultado del proceso de validación, aceptación o rechazo del documento.

Para realizar el consumo de la API, es necesario definir el entorno de trabajo en el que se ejecutará la solicitud.

SOVOS Saphety dispone de dos ambientes (Pruebas y Producción), los cuales se encuentran detallados 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

Cuando la solicitud se procesa correctamente, el servicio devuelve una respuesta con código HTTP 200 (OK).

Para identificar el estado actual del documento, se debe revisar el campo Status dentro del mensaje de respuesta. Este campo indica la situación del documento en el flujo de validación ante la DIAN (por ejemplo: Enviado, Validado, Rechazado, En procesamiento, entre otros).

resultFE

status: 400 Bad Request

Para identificar las causales de rechazo, se debe revisar el mensaje de respuesta del servicio, específicamente la sección ResultData del documento.

En esta sección se detallan los motivos o errores detectados durante el proceso de validación del documento electrónico ante la DIAN.

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: