Orçamentos e despesas – 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.

Orçamentos e despesas

Planos financeiros, alocações, grupos de custos e transações.

Visão geral da entidade

Orçamento

Expor orçamentos do Flowtly a ferramentas financeiras para garantir que alocações, alertas e aprovações ficam sincronizados.

Endpoints

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

Listar orçamentos

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

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

Criar orçamento

Cria um recurso Budget.

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

Obter orçamento por ID

Obter um único recurso pelo seu identificador.

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

Eliminar orçamento

Eliminar o recurso.

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

Atualizar orçamento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Aprovisionar centros de custo anuais a partir do seu ERP e manter o Flowtly atualizado com os limites mais recentes.

Sincronizar orçamentos de campanhas de marketing para que as ferramentas de desempenho possam parar despesas quando o Flowtly sinaliza excessos.

Campos do esquema

Budget-budget.read_budget_employee.read_budget_project.read

Campo	Tipo	Descrição
`id`	string	Campo id.
`name`	string	Campo name.
`type`	string	Campo type.
`granularity`	string	Campo granularity.
`budgetGroup`	string \| null	Campo budgetGroup.
`attributeSet`	string \| null	Campo attributeSet.
`dateFrom`	string \| null	Campo dateFrom.
`dateTo`	string \| null	Campo dateTo.
`config`	array	Campo config.
`budgetEmployees`	array	Campo budgetEmployees.
`budgetProjects`	array	Campo budgetProjects.

Visão geral da entidade

Transação de orçamento

Partilhar dados de despesa em ambas as direções para que tanto os sistemas de aquisição como o Flowtly concordem com os montantes comprometidos mais recentes.

Endpoints

GET https://api.flowtly.eu/budget-transactions

Listar transações de orçamento

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

POST https://api.flowtly.eu/budget-transactions

Criar transação de orçamento

Cria um recurso BudgetTransaction.

GET https://api.flowtly.eu/budget-transactions/{id}

Obter transação de orçamento por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/budget-transactions/{id}

Eliminar transação de orçamento

Eliminar o recurso.

PATCH https://api.flowtly.eu/budget-transactions/{id}

Atualizar transação de orçamento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Enviar pagamentos de faturas do seu sistema contabilístico para que o Flowtly reflita a despesa real até à data.

Associar despesas de RH ou fornecedores a orçamentos no momento em que são aprovadas na sua pilha financeira.

Campos do esquema

BudgetTransaction-budget_transaction.read_transaction.read

Campo	Tipo	Descrição
`budget`	string	Campo budget.
`transaction`	object	Campo transaction.
`employee`	string \| null	Campo employee.
`amount`	string \| null	Campo amount.

Visão geral da entidade

Grupo de orçamento

Organizar orçamentos em grupos lógicos (departamentos, projetos, centros de custo) para relatórios consolidados.

Endpoints

GET https://api.flowtly.eu/budget-groups

Listar grupos de orçamento

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

POST https://api.flowtly.eu/budget-groups

Criar grupo de orçamento

Cria um recurso BudgetGroup.

GET https://api.flowtly.eu/budget-groups/{id}

Obter grupo de orçamento por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/budget-groups/{id}

Eliminar grupo de orçamento

Eliminar o recurso.

PATCH https://api.flowtly.eu/budget-groups/{id}

Atualizar grupo de orçamento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Espelhar a hierarquia do plano de contas nos grupos de orçamento do Flowtly.

Criar grupos de orçamento por unidade de negócio para dashboards consolidados de despesas.

Campos do esquema

BudgetGroup-budget_group.read_budget_group.projects.read

Campo	Tipo	Descrição
`id`	string	Campo id.
`name`	string	Campo name.
`projects`	array	Campo projects.

Visão geral da entidade

Custo e fornecedor

Acompanhar custos operacionais, agrupá-los para análise e gerir relações com prestadores/fornecedores.

Endpoints

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

Listar custos e fornecedores

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

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

Criar custo e fornecedor

Cria um recurso CostGroup.

POST https://api.flowtly.eu/contractors/nip-validation

Criar validação NIP

Cria um recurso Cost.

GET https://api.flowtly.eu/contractors/search

Listar pesquisa

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

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

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

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

Eliminar custo e fornecedor

Eliminar o recurso.

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

Atualizar custo e fornecedor

Atualizar campos do recurso utilizando JSON Merge Patch.

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

Listar custos e fornecedores

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

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

Criar custo e fornecedor

Cria um recurso CostGroup.

GET https://api.flowtly.eu/costs/payment-due/{date}

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

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

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

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

Atualizar custo e fornecedor

Atualizar campos do recurso utilizando JSON Merge Patch.

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

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

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

Listar custos e fornecedores

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

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

Criar custo e fornecedor

Cria um recurso CostGroup.

POST https://api.flowtly.eu/suppliers/nip-validation

Criar validação NIP

Cria um recurso Cost.

GET https://api.flowtly.eu/suppliers/search

Listar pesquisa

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

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

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

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

Eliminar custo e fornecedor

Eliminar o recurso.

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

Atualizar custo e fornecedor

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/cost-groups

Listar custos e fornecedores

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

POST https://api.flowtly.eu/cost-groups

Criar custo e fornecedor

Cria um recurso CostGroup.

POST https://api.flowtly.eu/cost-groups/assign-icons-ai

Criar atribuição de ícones por IA

Atribuir ícones de grupo de custos via IA

GET https://api.flowtly.eu/cost-groups/chart

Listar gráfico

Obter gráfico de grupos de custos

GET https://api.flowtly.eu/cost-groups/{id}

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/cost-groups/{id}

Atualizar custo e fornecedor

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/cost-groups/{id}/chart

Obter custo e fornecedor por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/cost-groups/{id}/merge

Fundir grupos de custos

Casos de uso

Sincronizar faturas de fornecedores em registos de custos para rastreio de margens em tempo real.

Importar tarifas de prestadores da aquisição para automatizar a estimativa de custos de projetos.

Campos do esquema

Cost-cost.read_cost_group.read

Campo	Tipo	Descrição
`id`	integer	Campo id.
`costGroup`	object	Campo costGroup.
`ownerEmployee`	string \| null	Campo ownerEmployee.
`tinType`	string	Campo tinType.
`tin`	string \| null	Campo tin.
`tinCountry`	string \| null	Campo tinCountry.
`cyclic`	boolean	Campo cyclic.
`paymentDeadline`	integer \| null	Campo paymentDeadline.
`name`	string	Campo name.
`description`	string \| null	Campo description.
`matchRegex`	string \| null	Campo matchRegex.
`requireAttachment`	boolean \| null	Campo requireAttachment.
`taxAmount`	string \| null	Campo taxAmount.
`notIncludeInChart`	boolean	Campo notIncludeInChart.
`eInvoicingReferenceNumber`	string \| null	Campo eInvoicingReferenceNumber.
`eInvoicingSourceXmlUrl`	string \| null	—
`eInvoicingVisualUrl`	string \| null	—
`createdAt`	string	—
`costGroupIcon`	string \| null	—
`contractorGroup`	object	—

Visão geral da entidade

Transação

Integrar dados de transações em sistemas bancários e ERP para manter o controlo de despesas e os relatórios de margem atualizados.

Endpoints

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

Listar transações

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

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

Criar transação

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transactions/import

Criar importação

Cria um recurso Transaction.

GET https://api.flowtly.eu/transactions/unassigned

Listar não atribuídas

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

GET https://api.flowtly.eu/transactions/with-problems

Listar com problemas

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

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

Obter transação por ID

Obter um único recurso pelo seu identificador.

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

Eliminar transação

Eliminar o recurso.

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

Atualizar transação

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/transactions/{id}/suggestions

Obter transação por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/transactions/{id}/suggestions/{suggestionId}/apply

Cria um recurso TransactionAttachment.

GET https://api.flowtly.eu/transactions/{id}/allocation/attributes

Obter transação por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/transactions/{id}/allocation/apply

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transactions/{id}/allocation/preview

Cria um recurso TransactionAllocationPreviewInput.

GET https://api.flowtly.eu/transaction-attachments

Listar transações

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

POST https://api.flowtly.eu/transaction-attachments

Criar transação

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transaction-attachments/create

Criar criar

Cria um recurso TransactionAttachment.

GET https://api.flowtly.eu/transaction-attachments/search

Listar pesquisa

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

GET https://api.flowtly.eu/transaction-attachments/{id}

Obter transação por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/transaction-attachments/{id}

Eliminar transação

Eliminar o recurso.

PATCH https://api.flowtly.eu/transaction-attachments/{id}

Atualizar transação

Atualizar campos do recurso utilizando JSON Merge Patch.

POST https://api.flowtly.eu/transaction-attachments/{id}/apply-suggestion

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transaction-attachments/{id}/apply-supplier-suggestion

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transaction-attachments/{id}/detach

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transaction-attachments/{id}/mark-manual-paid

Cria um recurso TransactionAttachment.

GET https://api.flowtly.eu/transaction-attachments/{id}/suggestions

Obter transação por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/transaction-attachments/{id}/suggestions-debug

Obter transação por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/transaction-attachments/{id}/suggestions/{suggestionId}/apply

Cria um recurso TransactionAttachment.

POST https://api.flowtly.eu/transactions/attachments/zip

Criar zip

Descarregar anexos de transação como zip

GET https://api.flowtly.eu/transactions/export/mt940

Listar mt940

Obtém um recurso TransactionMt940Export.

GET https://api.flowtly.eu/transactions/export/pdf

Listar pdf

Obtém um recurso TransactionPdfExport.

Casos de uso

Sincronizar transações contabilizadas com ferramentas de encerramento mensal para reconciliação mais rápida.

Alimentar fluxos de transações em alertas de orçamento e vistas de rentabilidade em tempo real.

Campos do esquema

TransactionAttachment-transaction.read_transaction_attachment.read_cost.read_storage.read

Campo	Tipo	Descrição
`id`	integer	Campo id.
`cost`	object	Campo cost.
`counterparty`	object	Campo counterparty.
`currency`	string \| null	Campo currency.
`relatedMonth`	string \| null	Campo relatedMonth.
`externalId`	string	Campo externalId.
`employee`	string \| null	Campo employee.
`amount`	integer \| null	Campo amount.
`amountNet`	integer \| null	Campo amountNet.
`name`	string	Campo name.
`description`	string	Campo description.
`note`	string \| null	Campo note.
`receivedAt`	string	Campo receivedAt.
`approvalsCount`	integer	Campo approvalsCount.
`suggestionsCount`	integer	Campo suggestionsCount.
`sourceType`	string	—
`type`	string	—
`paidAt`	string \| null	—
`transaction`	object	—
`invoiceLines`	array	—
`createdAt`	string	—
`counterpartyName`	string \| null	—
`status`	string	—

Visão geral da entidade

Conta bancária

Gerir registos de contas bancárias utilizados para encaminhamento de pagamentos, reconciliação e relatórios de tesouraria.

Endpoints

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

Listar contas bancárias

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

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

Criar conta bancária

Cria um recurso BankAccount.

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

Obter conta bancária por ID

Obter um único recurso pelo seu identificador.

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

Atualizar conta bancária

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/bank-accounts

Listar contas bancárias

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

POST https://api.flowtly.eu/bank-accounts

Criar conta bancária

Cria um recurso BankAccount.

GET https://api.flowtly.eu/bank-accounts/{id}

Obter conta bancária por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/bank-accounts/{id}

Atualizar conta bancária

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Registar novas contas bancárias a partir do seu sistema de tesouraria para correspondência de pagamentos.

Sincronizar saldos de contas para previsão de fluxo de caixa no Flowtly.

Campos do esquema

BankAccount-bank_account.read_bank.read

Campo	Tipo	Descrição
`id`	integer	Campo id.
`bank`	object	Campo bank.
`type`	string	Campo type.
`default`	boolean	Campo default.
`hidden`	boolean	Campo hidden.
`name`	string	Campo name.
`number`	string \| null	Campo number.
`prefix`	string \| null	Campo prefix.
`currency`	string \| null	Campo currency.
`defaultImportFormat`	string	Campo defaultImportFormat.

Visão geral da entidade

Grupo e regra de imposto

Definir grupos de impostos com regras associadas para cálculo preciso de impostos em faturas e transações.

Endpoints

GET https://api.flowtly.eu/tax-groups

Listar grupos e regras de imposto

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

POST https://api.flowtly.eu/tax-groups

Criar grupo e regra de imposto

Cria um recurso TaxRule.

GET https://api.flowtly.eu/tax-groups/{id}

Obter grupo e regra de imposto por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/tax-groups/{id}

Atualizar grupo e regra de imposto

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/tax-rules

Listar grupos e regras de imposto

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

POST https://api.flowtly.eu/tax-rules

Criar grupo e regra de imposto

Cria um recurso TaxRule.

GET https://api.flowtly.eu/tax-rules/{id}

Obter grupo e regra de imposto por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/tax-rules/{id}

Eliminar grupo e regra de imposto

Eliminar o recurso.

PATCH https://api.flowtly.eu/tax-rules/{id}

Atualizar grupo e regra de imposto

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Importar tabelas de taxas de IVA do seu sistema contabilístico para faturação consistente.

Configurar regras fiscais específicas de cada país para faturação em múltiplas jurisdições.

Campos do esquema

TaxGroup-tax_group.read_tax_rule.read

Campo	Tipo	Descrição
`id`	string	Campo id.
`name`	string	Campo name.
`isDefault`	boolean	Campo isDefault.
`taxRules`	array	Campo taxRules.

Visão geral da entidade

Moeda

Consultar moedas disponíveis utilizadas em faturas, orçamentos e transações.

Endpoints

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

Listar moedas

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

GET https://api.flowtly.eu/currencies/{!sourceCurrency}/rates/{!targetCurrency}/{date}

Obter moeda por ID

Obter um único recurso pelo seu identificador.

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

Obter moeda por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Consultar moedas suportadas antes de criar faturas em múltiplas moedas.

Sincronizar taxas de câmbio para relatórios financeiros consolidados.

Campos do esquema

Currency-currency.read

Campo	Tipo	Descrição
`id`	string	Campo id.
`name`	string	Campo name.