Consultar Metadatos (CUFE/CUDE) de un Documento de Facturación Electrónica

Consultar Metadatos (CUFE/CUDE) de un Documento de Facturación Electrónica#

Este servicio permite consultar los metadatos de los documentos electrónicos, es decir, los datos básicos asociados a las facturas, notas crédito o notas débito que han sido transmitidas de forma asincrónica a la DIAN.

Para consumir la API, es necesario tener en cuenta 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 descritos en el apartado de Entornos.

Consumo del Método de Consulta de Metadatos (CUFE/CUDE).#

metadatosFE

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}

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": {
        "DocumentStatusReason": "test",
        "DocumentStatusReasonCode": "Item_01",
        "PaymentStatus": "Unknown",
        "PaymentCorrelationId": null,
        "IsPdfGenerated": true,
        "Id": "742b3857-8adb-4e48-afec-2e165303ccb7",
        "DocumentType": "SalesInvoice",
        "DocumentSubType": null,
        "DocumentNumber": "SETP990053146",
        "OriginId": "037ddade-c8b1-4dba-9513-5ee955841197",
        "OriginName": "Saphety Transacciones Electrónicas S.A.S",
        "OriginCode": "CO_NIT_900606963",
        "DestinationId": "00000000-0000-0000-0000-000000000000",
        "DestinationName": "Saphety Transacciones Electrónicas S.A.S",
        "DestinationCode": "CO_NIT_900606963",
        "DocumentDate": "2023-02-13T17:12:12Z",
        "CreationDate": "2023-02-09T22:50:34.3766667Z",
        "DocumentStatus": "Rejected",
        "DocumentStatusDate": "2023-02-21T16:44:21.478164Z",
        "DocumentStatusApplicationResponseInvalidSignature": false,
        "CommunicationStatus": null,
        "CommunicationStatusComments": null,
        "MainEmailNotification": "correo@sovos.com",
        "MainEmailNotificationStatus": "NotSent",
        "MainEmailNotificationStatusReason": null,
        "Currency": "COP",
        "TotalAmount": 136850.0,
        "Cufe": "bf64cbcd03eeb35b3971931958be205f8a54ec2163074e8ac56952b84b13af776a166d6e8cc6f8a442563154cd57812f"
    },
    "ResultCode": 200
}
{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "Id",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "742b3857-8adb-4e48-afec-2e165303ccb6"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Important

Si al realizar la consulta la respuesta contiene el valor “Code”: “DocumentNotFound”, y desea conocer el estado o las causales de rechazo del documento, puede hacerlo a través del siguiente enlace: Obtener Estado o Causales de Rechazo.

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: