Documentos e armazenamento – construir no Flowtly

Utilize este instantâneo selecionado do esquema OpenAPI do Flowtly para planear integrações, automatizar fluxos de trabalho e sincronizar os dados em que as suas equipas confiam.

Estado da documentação

Última sincronização em 2026-04-03 18:31 (versão da aplicação 2.0.0)

Apenas um subconjunto de entidades é tornado público. Execute ambos os comandos de sincronização para atualizar esta documentação quando a aplicação Flowtly disponibilizar novas capacidades.

Documentos e armazenamento

Gestão de ficheiros, tipos de documentos e recursos de armazenamento.

Visão geral da entidade

Documento

Carregar, categorizar e obter documentos associados a colaboradores, clientes ou projetos.

Endpoints

GET https://api.flowtly.eu/documents

Listar documentos

Obtém a coleção de recursos DocumentType.

POST https://api.flowtly.eu/documents

Criar documento

Cria um recurso DocumentType.

GET https://api.flowtly.eu/documents/action-needed

Listar ação necessária

Obtém a coleção de recursos Document.

GET https://api.flowtly.eu/documents/{id}

Obter documento por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/documents/{id}

Eliminar documento

Eliminar o recurso.

PATCH https://api.flowtly.eu/documents/{id}

Atualizar documento

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/document-types

Listar documentos

Obtém a coleção de recursos DocumentType.

POST https://api.flowtly.eu/document-types

Criar documento

Cria um recurso DocumentType.

GET https://api.flowtly.eu/document-types/{id}

Obter documento por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/document-types/{id}

Atualizar documento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Anexar contratos assinados da sua ferramenta de assinatura eletrónica a acordos do Flowtly.
Categorizar documentos carregados com tipos personalizados para relatórios de conformidade.

Campos do esquema

Document-document.read_storage.read
Campo Tipo Descrição
id integer Campo id.
documentType string Campo documentType.
relationId integer Campo relationId.
expiringAt string | null Campo expiringAt.
storage object Campo storage.
notes string | null Campo notes.

Visão geral da entidade

Armazenamento

Carregar e descarregar ficheiros binários (imagens, PDFs, folhas de cálculo) associados a registos do Flowtly.

Endpoints

GET https://api.flowtly.eu/storage/mt940

Listar mt940

Obtém a coleção de recursos Storage.

POST https://api.flowtly.eu/storage/upload

Criar carregamento

Cria um recurso Storage.

GET https://api.flowtly.eu/storage/{id}

Obter armazenamento por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/storage/{id}

Eliminar armazenamento

Eliminar o recurso.

GET https://api.flowtly.eu/storage/{id}/preview

Obter armazenamento por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Carregar PDFs de faturas a partir do seu pipeline de digitalização.
Obter imagens de avatar de colaboradores para integrações de diretório.

Campos do esquema

Storage-document.read_storage.read
Campo Tipo Descrição
id string Campo id.
relationName string Campo relationName.
relationId string Campo relationId.
size integer Campo size.
mimeType string Campo mimeType.
Whatsapp