Metadatos documentales
Identificadores y relaciones de respaldos sin descargar archivos.
documentsModelo y significado
Los datos financieros se leen independientemente de los archivos. documentIds y relations permiten conservar trazabilidad sin descargar imágenes o PDF. La ruta path es privada; no es una URL de lectura. No incluirla en el futuro exportador.
status processed expresa procesamiento documental; no significa factura pagada ni mercadería recibida. Las recepciones de archivos por canal pertenecen a document_receipts y no al recurso receipts de cobros.
Consulta del recurso
GET https://finanzas.neavision.com.ar/api/v1/agent/documents
Authorization: Bearer <token-de-integracion>Requiere documents:read. Respuesta de lista: { data: [...], page: { total, nextCursor } }. El detalle se consulta con /documents/{id}. Ver paginación y filtros.
Diccionario de campos
Obligatorio / Opcional: campos del registro de negocio; dentro de una lista u objeto, se aplica cuando ese contenedor está presente. Servidor: identidad y auditoría. Respuesta: campos agregados o administrados por el servidor; no enviarlos como una edición ordinaria. La presencia de los calculados depende del endpoint.
| Campo | Tipo / valores | Condición | Significado y restricciones |
|---|---|---|---|
externalId | string | Opcional | Identidad opcional del sistema de origen. Única por recurso entre registros activos. Máx. 500 caracteres. |
notes | string | Opcional | Observaciones registradas. Máx. 10000 caracteres. |
name | string | Obligatorio | Nombre visible. Máx. 1000 caracteres. |
mime | string | Obligatorio | Tipo MIME del respaldo. Máx. 1000 caracteres. |
size | integer | Obligatorio | Tamaño del archivo en bytes. Mín. 1. Máx. 52428800. |
sha256 | string | Obligatorio | Hash de integridad del original. Patrón: ^[a-f0-9]{64}$ |
path | string | Obligatorio | Ruta privada de Storage; no es una URL pública. Máx. 500 caracteres. |
source | "web" | "gmail" | "telegram" | "api" | "migration" | Obligatorio | Canal de ingreso. |
receivedAt | date-time | Obligatorio | Instante de recepción del original, ISO 8601. |
status | "pending" | "processed" | "unsupported" | Obligatorio | Estado registrado o calculado, según el recurso y endpoint. |
externalMessageId | string | Opcional | Identificador del mensaje de origen. Máx. 500 caracteres. |
externalAttachmentId | string | Opcional | Identificador del adjunto de origen. Máx. 500 caracteres. |
classification | string | Opcional | Clasificación documental. Máx. 1000 caracteres. |
relations | array | Opcional | Relaciones a entidades del sistema. Máx. 100 elementos. |
relations[].resource | "customers" | "sales-invoices" | "receipts" | "sales-credits" | "payment-orders" | "products" | "delivery-notes" | "stock-movements" | "suppliers" | "invoices" | "expenses" | "payments" | "credits" | "commitments" | "recurrences" | "documents" | "issues" | "notification-rules" | "notifications" | Obligatorio | Nombre del recurso relacionado. |
relations[].id | uuid | Obligatorio | Identificador textual estable dentro de la lista de líneas, cuotas o anticipos; no es un UUID global. |
id | uuid | Servidor | Identificador UUID estable del registro. No usar el número de comprobante como ID. |
version | integer | Servidor | Versión entera para detectar cambios sobre este registro. Mín. 1. |
createdAt | date-time | Servidor | Momento de creación, ISO 8601 con zona. |
updatedAt | date-time | Servidor | Última modificación del registro; no implica que un saldo derivado se haya mantenido igual. |
voidedAt | date-time | Servidor | Momento de anulación; null o ausente indica registro activo. |