Método para obtener información de archivos adjuntos (GetDocumentAttachments)
Este método permite obtener información sobre los archivos adjuntos de un documento utilizando el servicio GET.
Por medio de este método, se obtiene la información respectiva a los archivos adjuntos del documento consultado. El método recupera información de todos los archivos adjuntos.
Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:
https://developers.gosocket.net/api/v1/File/GetDocumentAttachmentshttps://developers-sbx.gosocket.net/api/v1/File/GetDocumentAttachments¿Cómo funciona el método GetDocumentAttachments?
Para realizar la petición, el método tiene los siguientes parámetros:
| GetDocumentAttachments (request) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| globalDocumentId* | String | Identificación de documento en Gosocket | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
*Requerido
Ejemplo de petición
Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.
Al ser un método GET, utilizamos la pestaña Params en Postman para formar el query.
- Seleccione el tipo de método. En este caso, se debe seleccionar GET.
- Ingrese laURL del método.
- Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
- Presione Send.
Ejemplo de respuesta
Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes parámetros:
| GetDocumentAttachments (response) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| AttachmentId | String | Identificación única para el archivo adjunto | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Country | String | Código del País de emisión del documento | ar, bo, br, cl, co, cr, ec, gt, mx, pa, pe, py, do, sv, uy |
| Name | String | Nombre del archivo descargado | nombre.extensión (la extensión a veces no se muestra y depende de como se haya cargado el archivo a la plataforma) |
| Description | String | Descripción del archivo. | |
| AttachmentTypeId | Integer | Id del tipo de Adjunto de acuerdo con el medio por el cual fue subido o creado: 990: Gosocket API 999: ACK Process 1000: Gosocket Web | 990 999 1000 |
| Date | String | Fecha y hora en que se subió el archivo | aaaa-mm-ddThh:mm:ss |
| FileExt | String | Tipo o extensión del archivo | “extensión_archivo” |
| ShowSender | Boolean | Indica si el archivo lo puede ver el emisor | True: El archivo se muestra al emisor False: El archivo NO se muestra al emisor |
| ShowReceiver | Boolean | Indica si el archivo lo puede ver el receptor | True: El archivo se muestra al receptor False: El archivo NO se muestra al receptor |
| RefSenderCode | String | ID fiscal del emisor | Ver tabla Estructura ID Fiscal |
| RefReceiverCode | String | ID fiscal del receptor | Ver tabla Estructura ID Fiscal |
| RefDocumentTypeId | Integer | Código del Tipo de documento en Gosocket relacionado (factura, nota, etc) | 1, 2, 3, 4, … |
| RefDocumentId | String | Identificación de documento relacionado en Gosocket. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| RefCountryDocumentId | String | Identificador fiscal del documento relacionado a nivel país, conocido también como CUFE, CLAVE, UUID, ID | Ver tabla Estructura Country Document ID |
| RefDate | String | Fecha y hora del documento relacionado | aaaa-mm-ddThh:mm:ss |
| RefNumber | String | Número de documento o folio relacionado | |
| RefSeries | String | Serie del documento relacionado | |
| CreatedBy | String | Usuario de creación del archivo de acuerdo con el medio por el cual fue subido o creado: System: cuando algún proceso lo crea ID (36 caracteres): cuando se sube de forma manual desde Inbox UUID del usuario (ApiKey): subido por medio de la API | System UUID de 36 caracteres alfanuméricos. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| CreationSource | String | Fuente de creación del archivo | Gosocket API ACK Process Gosocket Web |
| Timestamp | String | Fecha y hora del archivo | aaaa-mm-ddThh:mm:ss |
| LastUpated | String | Fecha y hora del archivo | aaaa-mm-ddThh:mm:ss |
| AuthorityValidation | Integer | Código de validación de la entidad tributaria | |
| AuthorityValidationTimestamp | String | Fecha y hora de validación de la entidad tributaria | |
| GlobalTrackId | String | ID para tracking | 00000000-0000-0000-0000-000000000000 |
Características del método GetDocumentAttachments
-
Cuando no existe el Id del documento (globalDocumentId), el sistema responde un mensaje de error:
-
Se pueden consultar los archivos tantas veces como sea necesario.
-
Se mostrará información de todos los archivos adjuntos que tenga el documento.