Descargar Formatos de Documentos Recibidos#
Con este servicio se podrán descargar los diferentes formatos del proceso de los documentos recibidos como PDF, UBL-XML, AttachedDocument y adjuntos.
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 para descargar formato PDF.#
El Verbo Http (acción) que se utiliza para la consulta de este formato es:
GET
El método que se utiliza para la consulta de este formato es:
/v2/{virtualOperator}/inbounddocuments/{DocumentId}/pdf
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": {
"Id": "a395ec28-cca8-ed11-a2d6-00505695a8eb",
"FileName": "document.pdf",
"DocumentFormat": "PDF",
"Content": "PDF codificado en base64",
"ZipFileName": null
},
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "cufe",
"Code": "DocumentNotFound",
"Description": null,
"ExplanationValues": [
"88f71533-0a2a-"
]
}
],
"ResultData": null,
"ResultCode": 400
}
Note
Luego de recibir la respuesta con el PDF codificado en base64 ya se podrá hacer la conversión a PDF.
Consumo del método para descargar formato UBL - XML.#
El Verbo Http (acción) que se utiliza para la consulta de este formato es:
GET
El método que se utiliza para la consulta de este formato es:
/v2/{virtualOperator}/inbounddocuments/{DocumentId}/ubl
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": {
"Id": "a195ec28-cca8-ed11-a2d6-00505695a8eb",
"FileName": "SETP990053146.xml",
"DocumentFormat": "XML",
"Content": "UBL codificado en base64",
"ZipFileName": null
},
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "cufe",
"Code": "DocumentNotFound",
"Description": null,
"ExplanationValues": [
"88f71533-0a2a-"
]
}
],
"ResultData": null,
"ResultCode": 400
}
Note
Luego de recibir la respuesta con el UBL codificado en base64 ya se podrá hacer la conversión a XML.
Consumo del método para descargar formato AttachedDocument.#
El Verbo Http (acción) que se utiliza para la consulta de este formato es:
GET
El método que se utiliza para la consulta de este formato es:
/v2/{virtualOperator}/inbounddocuments/{DocumentId}/attacheddocument
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": {
"Id": "a295ec28-cca8-ed11-a2d6-00505695a8eb",
"FileName": "document.xml",
"DocumentFormat": "ATTACHED_DOCUMENT",
"Content": "AttachedDocument codificado en base64",
"ZipFileName": null
},
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "cufe",
"Code": "DocumentNotFound",
"Description": null,
"ExplanationValues": [
"88f71533-0a2a-"
]
}
],
"ResultData": null,
"ResultCode": 400
}
Note
Luego de recibir la respuesta con el AttachedDocument codificado en base64 ya se podrá hacer la conversión a XML.
Consumo del método para descargar formato Attachments.#
El Verbo Http (acción) que se utiliza para la consulta de este formato es:
GET
El método que se utiliza para la consulta de este formato es:
/v2/{virtualOperator}/inbounddocuments/{DocumentId}/attachments
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": [
{
"Id": "a495ec28-cca8-ed11-a2d6-00505695a8eb",
"Filename": "saphety/public/outbounddocuments/214e09025afe1229f636815f819325da93e19f7e1ea53b4ba719a383700e9cd23d646e1c68455ae10b7e5c740c3f00b62fe8c4ea5e36c08f/attachments/zip",
"ContentType": "text/uri-list",
"ContentLength": 161,
"Content": null
}
],
"ResultCode": 200
}
{
"IsValid": false,
"Warnings": [],
"Errors": [
{
"Field": "cufe",
"Code": "DocumentNotFound",
"Description": null,
"ExplanationValues": [
"88f71533-0a2a-"
]
}
],
"ResultData": null,
"ResultCode": 400
}
Note
Luego de recibir la respuesta con el link podrás acceder a los archivos adjuntos que contenga el documento.
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