Contas a Pagar e Receber

Gerencie contas a pagar e a receber com controle de status, fluxo de caixa e resumos financeiros consolidados.

GET/api/accounts

Lista contas a pagar e receber com paginacao e filtros.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`type`(query)	`string`	Nao	receivable ou payable
`status`(query)	`string`	Nao	pending, overdue ou paid
`clientId`(query)	`string`	Nao	Filtrar por cliente
`category`(query)	`string`	Nao	Categoria
`startDate`(query)	`string`	Nao	Data inicio (YYYY-MM-DD)
`endDate`(query)	`string`	Nao	Data fim (YYYY-MM-DD)

curl -s "https://flow.seudominio.com/api/accounts?type=receivable&status=pending" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Lista paginada

json

{
  "success": true,
  "data": {
    "accounts": [
      {
        "id": "clx...",
        "description": "Servico de consultoria - Empresa ABC",
        "amount": 5000.00,
        "type": "receivable",
        "status": "pending",
        "dueDate": "2026-03-01",
        "clientId": "clx...",
        "category": "servicos"
      }
    ],
    "total": 45,
    "page": 1,
    "limit": 20
  }
}

POST/api/accounts

Cria uma nova conta a pagar ou receber.

Body

Nome	Tipo	Obrigatorio	Descricao
`description`	`string`	Sim	Descricao da conta
`amount`	`number`	Sim	Valor
`type`	`string`	Sim	receivable ou payable
`dueDate`	`string`	Sim	Data de vencimento (YYYY-MM-DD)
`category`	`string`	Nao	Categoria
`clientId`	`string`	Nao	ID do cliente associado
`notes`	`string`	Nao	Observacoes

bash

curl -X POST "https://flow.seudominio.com/api/accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Servico de consultoria - Empresa ABC",
    "amount": 5000.00,
    "type": "receivable",
    "dueDate": "2026-03-01",
    "category": "servicos",
    "clientId": "clx123"
  }'

GET/api/accounts/receivables

Lista apenas contas a receber.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)

GET/api/accounts/payables

Lista apenas contas a pagar.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)

GET/api/accounts/{id}

Retorna detalhes de uma conta.

bash

curl -s "https://flow.seudominio.com/api/accounts/clx123" \
  -H "Authorization: Bearer $TOKEN" | jq .

PUT/api/accounts/{id}

Atualiza uma conta existente.

bash

curl -X PUT "https://flow.seudominio.com/api/accounts/clx123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 5500.00, "dueDate": "2026-03-15" }'

DELETE/api/accounts/{id}

Remove uma conta.

bash

curl -X DELETE "https://flow.seudominio.com/api/accounts/clx123" \
  -H "Authorization: Bearer $TOKEN"

POST/api/accounts/{id}/pay

Marca uma conta como paga.

curl -X POST "https://flow.seudominio.com/api/accounts/clx123/pay" \
  -H "Authorization: Bearer $TOKEN"

200Conta marcada como paga

json

{
  "success": true,
  "message": "Conta marcada como paga"
}

Resumo

GET/api/accounts/summary

Resumo consolidado de contas a pagar e receber.

200Resumo financeiro

json

{
  "success": true,
  "data": {
    "totalReceivable": 85000.00,
    "totalPayable": 32000.00,
    "pendingReceivable": 25000.00,
    "pendingPayable": 12000.00,
    "overdueReceivable": 5000.00,
    "overduePayable": 3000.00
  }
}

Fluxo de Caixa

GET/api/accounts/cash-flow

Projecao de fluxo de caixa baseada em contas pendentes.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`days`(query)	`integer`	Nao	Periodo em dias(default: `30`)

bash

curl -s "https://flow.seudominio.com/api/accounts/cash-flow?days=60" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Projecao de fluxo de caixa

json

{
  "success": true,
  "data": {
    "period": 60,
    "expectedIncome": 45000.00,
    "expectedExpenses": 18000.00,
    "projectedBalance": 27000.00,
    "entries": [
      { "date": "2026-03-01", "type": "receivable", "amount": 5000.00, "description": "Consultoria ABC" },
      { "date": "2026-03-05", "type": "payable", "amount": 2000.00, "description": "Servidor Cloud" }
    ]
  }
}