Saltar al contenido principal

Método para descargar el XML (DownloadDocumentXml)

Este método permite descargar el archivo XML de un documento utilizando el servicio GET DownloadDocumentXml.

Por medio de este método, se obtiene el archivo XML codificado en base 64 del documento consultado.

Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/File/DownloadDocumentXml
SANDBOXhttps://developers-sbx.gosocket.net/api/v1/File/DownloadDocumentXml

¿Cómo funciona el método DownloadDocumentXml?

Para realizar la petición, el método tiene los siguientes parámetros:

DownloadDocumentXml (request)
ParámetroTipoDescripciónValores permitidos
globalDocumentId*StringIdentificación de documento en Gosocket.UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
typeStringTipo de xml a descargarVer tabla de Tipos de archivos a descargar

*Requerido

Tipos de Archivos a descargar
TypeDescripciónPaises donde aplica
originalXML Fiscal (Tributario): XML que se envía a la Entidad Tributaria. Solo incluye los personalizados en los paises que la Entidad los soporta dentro del XML.AR, BO, CO, CR, DO, EC, PA, PE, PY, UY
defaultXML de Gosocket: XML que se almacena en Inbox, incluye los campos personalizadosTodos
responseRespuesta Entidad Tributaria: Archivo con la respuesta de la Entidad Tributaria para el documento emitido.Todos
smartsupplyXML de Smart Supply: XML que incluye los campos relacionados con la funcionalidad de SS.Todos los paises donde esté implementado SS
distributionXML de Distribución: XML que se distribuye de forma obligatoriaCO
addendaXML Addenda Comercial: XML con el nodo de AddendaMX
integrationArchivo JSON de integración: Archivo con el request enviado a la API para la emisión del documentoTodos

Ejemplo de petición

image-20240503-011727.png

Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.

Para este método utilizamos la pestaña Params de Postman.

  1. Seleccione el tipo de método. En este caso, se debe seleccionar GET.
  2. Ingrese la URL del método.
  3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
  4. Presione Send.

Ejemplo de Respuesta para la descarga de XML Default (Gosocket)

image-20240503-011937.png

Puede convertir la respuesta del parámetro Base64Content cuyo resultado, para este ejemplo, es el siguiente:

image-20240503-012004.png


Ejemplo de Respuesta para la descarga de XML distribution

image-20240503-012044.png

Puede convertir la respuesta del parámetro Base64Content cuyo resultado, para este ejemplo, es el siguiente:

image-20240503-012118.png


Ejemplo de Respuesta para la descarga de XML original (XML de la Entidad Tributaria)

image-20240503-012150.png

Puede convertir la respuesta del parámetro Base64Content cuyo resultado, para este ejemplo, es el siguiente:

image-20240503-012246.png

Nota: A diferencia de los otros tipos de XML, no contiene campos personalizados.


Ejemplo de Respuesta para la descarga de XML  Smart Supply

image-20240503-012713.png

Puede convertir la respuesta del parámetro Base64Content cuyo resultado, para este ejemplo, es el siguiente:

image-20240503-012859.png


Parámetros de repuesta

DownloadDocumentXml (response)
ParámetroTipoDescripciónValores permitidos
NameStringNombre del archivo XML descargadoglobalDocumentId.xml
DescriptionStringDescripción del evento realizado.Xml Content for GlobalDocumentId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Base64ContentStringArchivo XML codificado en base 64
TimeStampStringFecha y hora de creación del documentoaaaa-mm-ddThh:mm:ss
TypeStringTipo de archivo“xml”

Características del método

  • Cuando no existe el Id del documento (globalDocumentId), el sistema responde un mensaje de error:

    image-20240503-013410.png

  • Se puede descargar el archivo tantas veces como sea necesario.

  • Cuando no se especifica el parámetro type o se pone un valor fuera de la lista, la API responde con el XML tipo default.

  • El XML de distribución tiene doble codificación, por lo que será necesario decodificarlo 2 veces.