Consultar Documentos Recibidos

Este método permite consultar los distintos documentos recibidos y previamente procesados por nuestros servicios.

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

Consumo del método de consulta.

Verbo Http

El Verbo Http (acción) que se utiliza para la creación de este documento es:

POST

Método Http

El método que se utiliza para la creación de este documento es:

    /v2/{virtualOperator}/inbounddocuments/search

Parámetros

Para esta petición se requiere como parámetro el alias de su operador virtual.

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

Body

Estructura del mensaje JSON para consultar documentos recibidos.

A continuación encontrará la estructura base definida por Saphety para la consulta de un Documento Electrónico recibido.

JSON (DTO)

{
	"CreationDateStart": "2020-12-01T05:00:00.000Z",
	"CreationDateEnd": "2020-12-08T05:00:00.000Z",
    "DocumentTypes": [
    "SalesInvoice", "CreditNote", "DebitNote"
    ]
}

Note

Para consultar documentos recibidos, se pueden aplicar varias etiquetas y filtros dentro del JSON. Si deseas más información, consulta Swagger, que es el modelo del API de SOVOS Saphety:

• Ambiente de QA: https://api-factura-electronica-co-qa.saphety.com/swagger/index.html

• Ambiente de Producción: https://api-factura-electronica-co.saphety.com/swagger/index.html

Respuesta

status: 200 OK

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Items": [
            {
                "Id": "ee5a50fd-3048-4c08-8c6b-a58a62e89da2",
                "DocumentNumber": "SETP990002422",
                "SeriePrefix": "SETP",
                "DocumentType": "SalesInvoice",
                "DocumentSubType": null,
                "CreationDate": "2020-12-07T17:18:58.6533333Z",
                "DocumentDate": "2019-11-22T15:43:09Z",
                "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": 178500.0,
                "DocumentStatus": "Accepted",
                "DocumentStatusDate": "2020-12-07T17:22:26.9890418Z",
                "Cufe": "b17fbe5f0e61a282ff7255b1a268eb11251f406c0f4e16201ca7b242c1ff529fefdc4f5ae38fd2e6d8669dfeb8206032",
                "DocumentInvalidSignature": false,
                "TotalTaxableAmount": 150000.0,
                "VatTotalAmount": 28500.0
            }
        ],
        "Total": 1
    },
    "ResultCode": 200
}

status: 400 Bad Request

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": null,
            "Code": "DeserializationError",
            "Description": "Error converting value \"CredsitNote\" to type 'Domain.Entities.ValueTypes.DocumentTypes'. Path 'DocumentTypes[1]', line 5, position 33.",
            "ExplanationValues": []
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}