Descargar Formatos de los Documentos de Nómina#
Con este servicio se podrán descargar los diferentes formatos del proceso de las nóminas emitidas como PDF, UBL-XML, AttachedDocument y DTO.
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}/payroll/{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#
El servicio retorna el formato en binario del PDF
El servicio solo indica el error 404 (Not Found)
Important
Luego de recibir la respuesta con el PDF codificado en binario 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}/payroll/{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#
El servicio retorna el formato en binario del XML - UBL
El servicio solo indica el error 404 (Not Found)
Important
Luego de recibir la respuesta con el XML -UBL codificado en binario 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}/payroll/{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#
El servicio retorna el formato en binario del AttachedDocument
El servicio solo indica el error 404 (Not Found)
Important
Luego de recibir la respuesta con el AttachedDocument codificado en binario ya se podrá hacer la conversión a XML.
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}/payroll/{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#
El servicio retorna el formato en binario del DTO o Json
El servicio solo indica el error 404 (Not Found)
Important
Luego de recibir la respuesta con el DTO codificado en binario ya se podrá hacer la conversión a JSON.
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