Consultar Metadatos (CUDS) de un Documento Soporte Electrónico

Consultar Metadatos (CUDS) de un Documento Soporte Electrónico#

Este servicio permite consultar los metadatos, es decir, los datos básicos de los documentos electrónicos transmitidos de forma asincrónica.

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

Consumo del método de consulta de metadatos (CUDS).#

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": null,
        "DocumentStatusReasonCode": null,
        "PaymentStatus": "Unknown",
        "PaymentCorrelationId": null,
        "IsPdfGenerated": true,
        "Id": "40120177-845e-4612-bbe1-9acb34207927",
        "DocumentType": "SupportDocumentAdjustment",
        "DocumentSubType": "",
        "DocumentNumber": "NADS6",
        "OriginId": "00000000-0000-0000-0000-000000000000",
        "OriginName": "Vendedor SAS",
        "OriginCode": "CO_NIT_900900900",
        "DestinationId": "037ddade-c8b1-4dba-9513-5ee955841197",
        "DestinationName": "Saphety Transacciones Electrónicas S.A.S",
        "DestinationCode": "CO_NIT_900606963",
        "DocumentDate": "2022-07-18T17:35:32Z",
        "CreationDate": "2023-02-10T00:28:38.26Z",
        "DocumentStatus": "Certified",
        "DocumentStatusDate": "2023-02-10T00:28:38.2623931Z",
        "DocumentStatusApplicationResponseInvalidSignature": false,
        "CommunicationStatus": null,
        "CommunicationStatusComments": null,
        "MainEmailNotification": "correo@correo.com",
        "MainEmailNotificationStatus": "NotSent",
        "MainEmailNotificationStatusReason": null,
        "Currency": "COP",
        "TotalAmount": 119000.0,
        "Cufe": "304bf4ee9bb257cdeef0f4be88a68a5f6a6d9ffa29282593ca4e525c403ceb686c9fbcfeca2a808679c860c67e3942da"
    },
    "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 es “Code”: “DocumentNotFound” y desea conocer el estado o las causales de rechazo, puede obtener esta información consultando en el 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: