Consultar Estado de Documentos Recibidos

Consultar Estado de Documentos Recibidos#

Con este servicio, es posible consultar el estado actual de los documentos recibidos.

Para consumir la API, es importante tener en cuenta el entorno en el que se trabajará. SOVOS Saphety cuenta con dos ambientes, los cuales se especifican en el apartado de Entornos.

Consumo del método de consulta de estado.#

estadoRE

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}/inbounddocuments/{DocumentId}

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

Parametro 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”.

Parametro DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el codigo identificador unico del documento recibido.

Respuesta#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "DocumentStatusReason": "test",
        "DocumentStatusReasonCode": "Item_01",
        "PaymentStatus": "Unknown",
        "PaymentCorrelationId": null,
        "IsPdfGenerated": true,
        "Id": "88f71533-0a2a-4c9e-a041-5155aa84946a",
        "DocumentNumber": "SETP990053146",
        "SeriePrefix": "SETP",
        "DocumentType": "SalesInvoice",
        "DocumentSubType": null,
        "CreationDate": "2023-02-09T22:50:39.7833333Z",
        "DocumentDate": "2023-02-13T17:12:12Z",
        "Currency": "COP",
        "OriginName": "Saphety Transacciones Electrónicas S.A.S",
        "OriginCode": "CO_NIT_900606963",
        "DestinationName": "Saphety Transacciones Electrónicas S.A.S",
        "DestinationCode": "CO_NIT_900606963",
        "TotalAmount": 136850.0,
        "DocumentStatus": "Rejected",
        "DocumentStatusDate": "2023-02-21T16:44:21.478164Z",
        "Cufe": "bf64cbcd03eeb35b3971931958be205f8a54ec2163074e8ac56952b84b13af776a166d6e8cc6f8a442563154cd57812f",
        "DocumentInvalidSignature": false,
        "TotalTaxableAmount": 0.0,
        "VatTotalAmount": null
    },
    "ResultCode": 200
}

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

Important

Para identificar el estado del documento, se debe revisar el campo DocumentStatus.

estadoDocRE

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: