Descargar formatos de documentos electrónicos#
Este servicio permite descargar los diferentes formatos asociados al proceso de emisión de los documentos electrónicos, tales como:
PDF
UBL-XML
AttachedDocument
DTO
Para realizar el consumo de la API, es necesario definir previamente el entorno de trabajo en el que se ejecutará la solicitud.
SOVOS Saphety dispone de dos ambientes (Pruebas y Producción), los cuales se encuentran detallados 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}/outbounddocuments/{documentId}/pdf/content
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 del Servicio#
Cuando la solicitud se procesa correctamente, el servicio retorna el formato en binario del archivo PDF correspondiente al documento electrónico solicitado.
Indica que la solicitud no pudo ser procesada correctamente. Esto puede deberse a parámetros incorrectos o a que el documento solicitado no existe.
Important
Una vez recibida la respuesta con el PDF codificado en binario, se podrá realizar la conversión o decodificación del archivo para obtener el documento en formato PDF legible.
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}/outbounddocuments/{documentId}/ubl/content
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 del Servicio#
El servicio retorna el archivo XML - UBL en formato binario correspondiente al documento electrónico solicitado.
Indica que el documento solicitado no fue encontrado o no existe en el sistema.
Important
Una vez recibida la respuesta con el XML - UBL codificado en binario, se podrá realizar la conversión para obtener el archivo en formato XML legible.
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}/outbounddocuments/{documentId}/attacheddocument/content
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 del Servicio#
El servicio retorna el archivo AttachedDocument en formato binario correspondiente al documento electrónico solicitado.
Indica que el documento solicitado no fue encontrado o no existe en el sistema.
Important
Una vez recibida la respuesta con el AttachedDocument codificado en binario, se podrá realizar la conversión para obtener el archivo en formato XML legible.
Consumo del método para descargar formato DTO - Json.#
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}/outbounddocuments/{documentId}/dto/content
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 del Servicio#
El servicio retorna el archivo DTO o JSON en formato binario correspondiente al documento electrónico solicitado.
Indica que el documento solicitado no fue encontrado o no existe en el sistema.
Important
Una vez recibida la respuesta con el DTO codificado en binario, se podrá realizar la conversión para obtener el archivo en formato JSON legible.
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:
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