Faturação e pagamentos – 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.

Faturação e pagamentos

Ciclo de vida de faturas, linhas, transações, faturação eletrónica e métodos de pagamento.

Visão geral da entidade

Fatura

Expor dados do ciclo de vida de faturas para que as finanças, operações e equipas de clientes partilhem uma única fonte de verdade para a receita faturada.

Endpoints

POST https://api.flowtly.eu/e-invoices/send

Criar envio

Cria um recurso Invoice.

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

Listar faturas

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

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

Criar fatura

Cria um recurso Invoice.

GET https://api.flowtly.eu/invoices/draft

Listar rascunhos

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

GET https://api.flowtly.eu/invoices/name/{date}

Obter fatura por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/invoices/send

Criar envio

Cria um recurso Invoice.

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

Obter fatura por ID

Obter um único recurso pelo seu identificador.

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

Eliminar fatura

Eliminar o recurso.

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

Atualizar fatura

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/invoices/{id}/send

Obter fatura por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/invoices/{id}/send

Cria um recurso Invoice.

Cria um recurso Invoice.

Casos de uso

Sincronizar faturas em dashboards de BI para monitorizar contas a receber em atraso e risco de fluxo de caixa.
Acionar fluxos de trabalho de lembretes a clientes quando o estado da fatura muda no Flowtly.

Campos do esquema

Invoice-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Campo Tipo Descrição
id integer Campo id.
name string Campo name.
type string Campo type.
parent object Campo parent.
childrenInvoices array Campo childrenInvoices.
client string Campo client.
tinType string Campo tinType.
tinCountry string | null Campo tinCountry.
tin string | null Campo tin.
bankAccount string Campo bankAccount.
amountNet number Campo amountNet.
amount number Campo amount.
currency string | null Campo currency.
conversionRate number | null Campo conversionRate.
generatedPdfExternalId string | null Campo generatedPdfExternalId.
issueDate string —
saleDate string —
dueDate string —
targetAmount number | null —
paymentMethod string —
paidInAdvance boolean —
notes string | null —
correctionReason string | null —
invoiceRows array —
eInvoicing object —
invoiceTransactions array —
internalComment string —
targetAmountNet number | null —
status string —

Visão geral da entidade

Linha de fatura

Gerir linhas de fatura com quantidade, preço unitário, imposto e descrição para controlo de faturação granular.

Endpoints

GET https://api.flowtly.eu/invoice-rows

Listar linhas de fatura

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

POST https://api.flowtly.eu/invoice-rows

Criar linha de fatura

Cria um recurso InvoiceRow.

GET https://api.flowtly.eu/invoice-rows/{id}

Obter linha de fatura por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/invoice-rows/{id}

Atualizar linha de fatura

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Gerar linhas de fatura a partir de folhas de horas aprovadas automaticamente.
Enviar correções de linhas do seu sistema contabilístico.

Campos do esquema

InvoiceRow-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Campo Tipo Descrição
id integer Campo id.
classificationNumber string | null Campo classificationNumber.
unit string | null Campo unit.
quantity number Campo quantity.
vatRate string Campo vatRate.
netPrice string Campo netPrice.
netDiscountAmount string Campo netDiscountAmount.
productName string Campo productName.
project string | null Campo project.
parentInvoiceRow object Campo parentInvoiceRow.
invoiceChildrenRows array Campo invoiceChildrenRows.

Visão geral da entidade

Transação de fatura

Acompanhar quais transações bancárias liquidam quais faturas para reconciliação automatizada.

Endpoints

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

Listar transações de fatura

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

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

Criar transação de fatura

Cria um recurso InvoiceTransaction.

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

Obter transação de fatura por ID

Obter um único recurso pelo seu identificador.

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

Eliminar transação de fatura

Eliminar o recurso.

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

Atualizar transação de fatura

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Associar pagamentos recebidos a faturas em aberto a partir do seu feed bancário.
Reconciliar pagamentos parciais e sobrepagamentos em conjuntos de faturas.

Campos do esquema

InvoiceTransaction-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Campo Tipo Descrição
id integer Campo id.
invoice object Campo invoice.
transaction object Campo transaction.
amount number | null Campo amount.
date string Campo date.

Visão geral da entidade

Faturação eletrónica (KSeF)

Enviar, receber e consultar faturas eletrónicas através da plataforma governamental KSeF para conformidade fiscal.

Endpoints

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/download/xml

Listar xml

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

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/{id}/download/upo

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/e-invoicing/invoices/inbound/{id}/download/xml

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/e-invoicing/invoices/inbound/queue

Criar fila

Cria um recurso InboundInvoiceQueue.

POST https://api.flowtly.eu/e-invoicing/invoices/inbound/sync

Criar sincronização

Cria um recurso InboundInvoiceSync.

POST https://api.flowtly.eu/e-invoicing/invoices/{id}/correction

Cria um recurso InvoiceCorrectionSend.

Cria um recurso InvoiceCorrectionSend.

GET https://api.flowtly.eu/e-invoicing/invoices/download/xml

Listar xml

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

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/pdf

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/preview/pdf

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/upo

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/e-invoicing/invoices/{id}/download/xml

Obter faturação eletrónica (ksef) por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/e-invoicing/invoices/{id}/send

Cria um recurso InvoiceSend.

Cria um recurso InvoiceSend.

POST https://api.flowtly.eu/e-invoicing/ksef/session

Criar sessão

Cria um recurso KsefSession.

Casos de uso

Submeter automaticamente faturas de vendas ao KSeF e armazenar o recibo UPO oficial.
Descarregar faturas de compra recebidas do KSeF para o seu fluxo de contas a pagar.

Campos do esquema

InvoiceEInvoicing.jsonld-invoice.read_invoice_row.read_invoice_transaction.read_transaction.read_storage.read
Campo Tipo Descrição
@context object —
@id string —
@type string —
id integer —
provider string —
status string —
referenceNumber string | null —
documentId string | null —
acquisitionTimestamp string | null —
upoUrl string | null —
verificationLink string | null —
rejectionReason string | null —
providerPayload array | null —
einvoicingNumber string | null —

Visão geral da entidade

Método de pagamento

Configurar métodos de pagamento (transferência bancária, cartão, etc.) e acompanhar transações de pagamento.

Endpoints

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

Listar métodos de pagamento

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

GET https://api.flowtly.eu/payment-methods

Listar métodos de pagamento

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

POST https://api.flowtly.eu/payment-methods/create-setup-intent

Criar intenção de configuração

Cria um recurso PaymentMethod.

GET https://api.flowtly.eu/payment-methods/{id}

Obter método de pagamento por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/payment-methods/{id}

Eliminar método de pagamento

Eliminar o recurso.

PATCH https://api.flowtly.eu/payment-methods/{id}

Atualizar método de pagamento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Definir condições de pagamento predefinidas por cliente para geração de faturas.
Consultar o histórico de pagamentos para extratos de conta de clientes.

Campos do esquema

PaymentMethod-payment_method.read
Campo Tipo Descrição
id string Campo id.
type string Campo type.
ccBrand string Campo ccBrand.
ccLastDigits string Campo ccLastDigits.
ccExpMonth integer Campo ccExpMonth.
ccExpYear integer Campo ccExpYear.
externalId string Campo externalId.
Whatsapp