Consultar Estado de un Documento Soporte Electrónico#
Con este servicio se podrá consultar el estado actual de los documentos electrónicos transmitidas asincrónicamente.
Para hacer el consumo de la API se deben tener en cuenta en que entorno se va a trabajar, SOVOS Saphety cuenta con dos ambientes especificados en el apartado de Entornos.
Consumo del método de consulta de estado.#
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
Para identificar el estado en el que se encuentra el documento, revisar el mensaje de respuesta el campo Status.
status: 400 Bad Request
Para identificar las Cuasales de rechazo estas se encuentra el documento, revisar el mensaje de respuesta la sección ResultData.
Referencia: Swagger#
Si quieres más información dirígete a Swagger que es el modelo del API de SOVOS Saphety, para el ambiente de QA https://api-factura-electronica-co-qa.saphety.com/swagger/index.html y para el ambiente de producción https://api-factura-electronica-co.saphety.com/swagger/index.html