Referência

Tesouraria

Onde está o dinheiro: as contas da empresa (caixas e bancos), os lançamentos, as transferências entre contas, as receitas avulsas, o fluxo de caixa, a conciliação bancária e o fecho de período. O extracto das contas só se acrescenta; erros corrigem-se com estornos.

Operação	O que faz
GET `/api/financeiro/contas`	As contas financeiras da empresa (caixas e bancos) com o saldo calculado.
GET `/api/financeiro/contas/{id}/extracto`	O extracto de uma conta: os movimentos por ordem, com os totais do período.
POST `/api/financeiro/contas`	Cria uma conta bancária.
PUT `/api/financeiro/contas/{id}`	Altera o nome, o banco, o número da conta e o IBAN de uma conta bancária.
PUT `/api/financeiro/contas/{id}/saldo-inicial`	Define o saldo inicial de uma conta e a data a partir da qual os movimentos contam.
PUT `/api/financeiro/contas/{id}/activa`	Activa ou desactiva uma conta.
POST `/api/financeiro/contas/{id}/por-omissao`	Faz desta conta bancária a conta por omissão (a que recebe os pagamentos que não são em numerário).
GET `/api/financeiro/lancamentos`	Os lançamentos de todas as contas, por categoria e centro de custo.
POST `/api/financeiro/transferencias`	Transfere dinheiro de uma conta para outra (por exemplo, depositar numerário no banco).
POST `/api/financeiro/transferencias/{id}/estornar`	Estorna uma transferência: devolve o dinheiro à conta de origem, com o motivo.
POST `/api/financeiro/receitas`	Regista uma receita avulsa (dinheiro que entra e não vem de um documento: um juro, um subsídio, um reembolso).
POST `/api/financeiro/receitas/{id}/estornar`	Estorna uma receita avulsa, com o motivo.
GET `/api/financeiro/fluxo-caixa/realizado`	O fluxo de caixa realizado: o que de facto entrou e saiu num período, por categoria.
GET `/api/financeiro/fluxo-caixa/realizado/csv`	O mesmo fluxo de caixa realizado, num ficheiro CSV (para abrir no Excel).
GET `/api/financeiro/fluxo-caixa/previsto`	A projecção do saldo nos próximos dias, com o que está para receber e para pagar.
GET `/api/financeiro/fluxo-caixa/indicadores`	Os indicadores de tesouraria de um período: prazos médios de recebimento e de pagamento, retenção…
GET `/api/financeiro/conciliacao/{contaId}`	O estado da conciliação bancária de uma conta: até quando está conciliada, o saldo conciliado, o saldo no sistema e a trilha das conciliações.
GET `/api/financeiro/conciliacao/{contaId}/movimentos`	Os movimentos de uma conta bancária que ainda não estão conciliados, até ao dia do extracto do banco (inclusive).
POST `/api/financeiro/conciliacao/{contaId}`	Concilia uma conta: marca como conferidos os movimentos que batem com o extracto do banco.
POST `/api/financeiro/conciliacao/desfazer/{id}`	Desfaz a conciliação mais recente de uma conta: os movimentos voltam a ficar por conciliar.
GET `/api/financeiro/periodos`	Os períodos financeiros: até quando a contabilidade está fechada.
POST `/api/financeiro/periodos/fechar`	Fecha um mês: depois de fechado, nada se lança nem se estorna nesse mês.
POST `/api/financeiro/periodos/reabrir`	Reabre um mês fechado, com o motivo.

GET/api/financeiro/contas#

As contas financeiras da empresa (caixas e bancos) com o saldo calculado.

Permissão Financeiro.ContasLer

O saldo é o saldo inicial mais os movimentos do extracto. saldoNegativo avisa quando uma conta está abaixo de zero (nunca bloqueia nada). A conta Caixa de cada estabelecimento e o banco por omissão criam-se sozinhos.

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/contas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/contas/{id}/extracto#

O extracto de uma conta: os movimentos por ordem, com os totais do período.

Permissão Financeiro.ContasLer

de e ate limitam o período (dias); sem eles, o extracto todo.

O extracto só se acrescenta: um erro corrige-se com um estorno, nunca com uma alteração.

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`de`	na pesquisa	data (AAAA-MM-DD)
`ate`	na pesquisa	data (AAAA-MM-DD)
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/contas/<id>/extracto' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/financeiro/contas#

Cria uma conta bancária.

Permissão Financeiro.ContasEditar
Idempotência aceita Idempotency-Key

As contas Caixa não se criam aqui: nascem com cada estabelecimento. Devolve o id da conta.

Corpo do pedido (JSON · CriarContaBancariaCommand)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`banco`	texto ou nulo
`numeroConta`	texto ou nulo
`iban`	texto ou nulo
`saldoInicial`	número ou nulo
`dataSaldoInicial`	data e hora (ISO 8601) ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto"
}'

PUT/api/financeiro/contas/{id}#

Altera o nome, o banco, o número da conta e o IBAN de uma conta bancária.

Permissão Financeiro.ContasEditar

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DadosContaBancariaRequest)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`banco`	texto ou nulo
`numeroConta`	texto ou nulo
`iban`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/financeiro/contas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto"
}'

PUT/api/financeiro/contas/{id}/saldo-inicial#

Define o saldo inicial de uma conta e a data a partir da qual os movimentos contam.

Permissão Financeiro.ContasEditar

É o ponto de partida do saldo calculado: o que a conta tinha antes de o Mucanda a acompanhar.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · SaldoInicialRequest)

Campo	Tipo	Obrigatório	Significado
`saldoInicial`	número	sim
`data`	data e hora (ISO 8601)	sim	A data e hora (UTC).

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/financeiro/contas/<id>/saldo-inicial' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "saldoInicial": 0,
  "data": "2026-10-12T09:00:00Z"
}'

PUT/api/financeiro/contas/{id}/activa#

Activa ou desactiva uma conta.

Permissão Financeiro.ContasEditar

Uma conta desactivada deixa de aceitar movimentos novos; os registos mantêm-se.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActivaRequest)

Campo	Tipo	Obrigatório
`activa`	verdadeiro/falso	sim

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/financeiro/contas/<id>/activa' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activa": false
}'

POST/api/financeiro/contas/{id}/por-omissao#

Faz desta conta bancária a conta por omissão (a que recebe os pagamentos que não são em numerário).

Permissão Financeiro.ContasEditar

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas/<id>/por-omissao' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/lancamentos#

Os lançamentos de todas as contas, por categoria e centro de custo.

Permissão Financeiro.ContasLer

de e ate são obrigatórios: nenhum pedido percorre o extracto inteiro. Filtros opcionais: contaId, categoriaId, centroCustoId, tipo, semCategoria e incluirTransferencias (por omissão, as transferências entre contas ficam de fora, porque só mudam o dinheiro de sítio).

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`de`	na pesquisa	data (AAAA-MM-DD)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim
`contaId`	na pesquisa	identificador (UUID)
`categoriaId`	na pesquisa	identificador (UUID)
`centroCustoId`	na pesquisa	identificador (UUID)
`tipo`	na pesquisa	texto
`semCategoria`	na pesquisa	verdadeiro/falso
`incluirTransferencias`	na pesquisa	verdadeiro/falso
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/lancamentos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/financeiro/transferencias#

Transfere dinheiro de uma conta para outra (por exemplo, depositar numerário no banco).

Permissão Financeiro.ContasTransferir
Idempotência aceita Idempotency-Key

Envie Idempotency-Key: repetir o pedido não o executa duas vezes. Ver Idempotência.

Origem e destino têm de ser contas diferentes. Gera dois movimentos ligados, na mesma operação. Devolve o id da transferência.

Corpo do pedido (JSON · TransferirEntreContasCommand)

Campo	Tipo	Obrigatório	Significado
`contaOrigemId`	identificador (UUID)	sim
`contaDestinoId`	identificador (UUID)	sim
`valor`	número	sim	O valor.
`descricao`	texto ou nulo		A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/transferencias' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "contaOrigemId": "00000000-0000-0000-0000-000000000000",
  "contaDestinoId": "00000000-0000-0000-0000-000000000000",
  "valor": 0
}'

POST/api/financeiro/transferencias/{id}/estornar#

Estorna uma transferência: devolve o dinheiro à conta de origem, com o motivo.

Permissão Financeiro.ContasTransferir
Idempotência aceita Idempotency-Key

Uma transferência só se estorna uma vez. Devolve o id do estorno.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EstornarTransferenciaRequest)

Campo	Tipo	Obrigatório
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/transferencias/<id>/estornar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'

POST/api/financeiro/receitas#

Regista uma receita avulsa (dinheiro que entra e não vem de um documento: um juro, um subsídio, um reembolso).

Permissão Financeiro.ReceitasRegistar
Idempotência aceita Idempotency-Key

Envie Idempotency-Key: repetir o pedido não o executa duas vezes. Ver Idempotência.

Leva conta, valor, data e categoria. Devolve o id da receita.

Corpo do pedido (JSON · RegistarReceitaAvulsaCommand)

Campo	Tipo	Obrigatório	Significado
`contaFinanceiraId`	identificador (UUID)	sim
`categoriaFinanceiraId`	identificador (UUID)	sim
`valor`	número	sim	O valor.
`descricao`	texto	sim	A descrição.
`centroCustoId`	identificador (UUID) ou nulo
`data`	data e hora (ISO 8601) ou nulo		A data e hora (UTC).
`pagador`	texto ou nulo
`referencia`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/receitas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "contaFinanceiraId": "00000000-0000-0000-0000-000000000000",
  "categoriaFinanceiraId": "00000000-0000-0000-0000-000000000000",
  "valor": 0,
  "descricao": "texto"
}'

POST/api/financeiro/receitas/{id}/estornar#

Estorna uma receita avulsa, com o motivo.

Permissão Financeiro.ReceitasRegistar
Idempotência aceita Idempotency-Key

Devolve o id do estorno. Uma receita só se estorna uma vez.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EstornarTransferenciaRequest)

Campo	Tipo	Obrigatório
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/receitas/<id>/estornar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'

GET/api/financeiro/fluxo-caixa/realizado#

O fluxo de caixa realizado: o que de facto entrou e saiu num período, por categoria.

Permissão Financeiro.ContasLer

de e ate (dias) obrigatórios; contaId limita a uma conta; comparar junta o período anterior da mesma duração.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`de`	na pesquisa	data (AAAA-MM-DD)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim
`contaId`	na pesquisa	identificador (UUID)
`granularidade`	na pesquisa	uma de: «Auto», «Dia», «Semana», «Mes»

Resposta (200 · JSON)

Campo	Tipo	Significado
`de`	data (AAAA-MM-DD)
`ate`	data (AAAA-MM-DD)
`contaId`	identificador (UUID) ou nulo
`granularidade`	texto
`saldoInicial`	número
`entradas`	número
`saidas`	número
`transferencias`	número
`ajustesDeSaldoInicial`	número
`saldoFinal`	número
`actividades`	lista de objectos
`actividades[].actividade`	texto
`actividades[].entradas`	número
`actividades[].saidas`	número
`actividades[].liquido`	número
`actividades[].rubricas`	lista de objectos
`actividades[].rubricas[].nome`	texto	O nome.
`actividades[].rubricas[].entradas`	número
`actividades[].rubricas[].saidas`	número
`actividades[].rubricas[].liquido`	número
`periodos`	lista de objectos
`periodos[].inicio`	data (AAAA-MM-DD)
`periodos[].fim`	data (AAAA-MM-DD)
`periodos[].entradas`	número
`periodos[].saidas`	número
`periodos[].saldoFinal`	número

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/fluxo-caixa/realizado' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/fluxo-caixa/realizado/csv#

O mesmo fluxo de caixa realizado, num ficheiro CSV (para abrir no Excel).

Permissão Financeiro.ContasLer

Os mesmos parâmetros do fluxo realizado. A resposta é o ficheiro.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`de`	na pesquisa	data (AAAA-MM-DD)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim
`contaId`	na pesquisa	identificador (UUID)
`comparar`	na pesquisa	verdadeiro/falso

Resposta

Devolve 200 com o ficheiro CSV (text/csv).

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/fluxo-caixa/realizado/csv' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/fluxo-caixa/previsto#

A projecção do saldo nos próximos dias, com o que está para receber e para pagar.

Permissão Financeiro.ContasLer

horizonte são os dias à frente (por omissão 90). incluirReceberVencido conta também o que já devia ter entrado.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`horizonte`	na pesquisa	número inteiro
`incluirReceberVencido`	na pesquisa	verdadeiro/falso

Resposta (200 · JSON)

Campo	Tipo	Significado
`hoje`	data (AAAA-MM-DD)	A facturação de hoje.
`horizonte`	número inteiro
`saldoActual`	número
`receberVencido`	número
`pagarVencido`	número
`incluiReceberVencido`	verdadeiro/falso
`totalAReceber`	número
`totalAPagar`	número
`saldoFinalProjectado`	número
`saldoMinimoProjectado`	número
`primeiroDiaNegativo`	data (AAAA-MM-DD) ou nulo
`diasDeCaixa`	número inteiro ou nulo
`pontos`	lista de objectos
`pontos[].data`	data (AAAA-MM-DD)	A data e hora (UTC).
`pontos[].aReceber`	número
`pontos[].aPagar`	número
`pontos[].saldo`	número
`pontos[].aPagarRecorrente`	número
`pontos[].aReceberAvencas`	número
`totalAPagarRecorrente`	número
`totalAReceberAvencas`	número

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/fluxo-caixa/previsto' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/fluxo-caixa/indicadores#

Os indicadores de tesouraria de um período: prazos médios de recebimento e de pagamento, retenção…

Permissão Financeiro.ContasLer

de e ate (dias) obrigatórios.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`de`	na pesquisa	data (AAAA-MM-DD)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim

Resposta (200 · JSON)

Campo	Tipo
`de`	data (AAAA-MM-DD)
`ate`	data (AAAA-MM-DD)
`prazoMedioRecebimentoDias`	número ou nulo
`baseRecebimentos`	número
`prazoMedioPagamentoDias`	número ou nulo
`basePagamentos`	número
`retencaoSuportada`	número
`recebimentosRegistos`	número inteiro
`pagamentosRegistos`	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/fluxo-caixa/indicadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/conciliacao/{contaId}#

O estado da conciliação bancária de uma conta: até quando está conciliada, o saldo conciliado, o saldo no sistema e a trilha das conciliações.

Permissão Financeiro.ContasLer

Só as contas bancárias se concilam: o numerário confere-se no fecho de caixa.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`contaId`	no caminho	identificador (UUID)	sim

Resposta (200 · JSON)

Campo	Tipo	Significado
`contaFinanceiraId`	identificador (UUID)
`conta`	texto
`conciliadaAte`	data (AAAA-MM-DD) ou nulo
`saldoConciliado`	número
`saldoNoSistema`	número
`movimentosPorConciliar`	número inteiro
`podeDesfazer`	identificador (UUID) ou nulo
`historico`	lista de objectos
`historico[].id`	identificador (UUID)	Identificador único (UUID).
`historico[].sequencia`	número inteiro
`historico[].dataExtracto`	data (AAAA-MM-DD)
`historico[].saldoExtracto`	número
`historico[].saldoAnterior`	número
`historico[].totalMovimentos`	número
`historico[].numeroMovimentos`	número inteiro
`historico[].observacao`	texto ou nulo	O texto livre.
`historico[].realizadaPorNome`	texto ou nulo
`historico[].realizadaEmUtc`	data e hora (ISO 8601)
`historico[].anulada`	verdadeiro/falso
`historico[].motivoAnulacao`	texto ou nulo	O motivo, quando o documento foi anulado.
`historico[].anuladaPorNome`	texto ou nulo
`historico[].anuladaEmUtc`	data e hora (ISO 8601) ou nulo

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/conciliacao/<contaId>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/financeiro/conciliacao/{contaId}/movimentos#

Os movimentos de uma conta bancária que ainda não estão conciliados, até ao dia do extracto do banco (inclusive).

Permissão Financeiro.ContasLer

ate (dia do extracto) obrigatório. Do mais antigo para o mais recente.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`contaId`	no caminho	identificador (UUID)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim

Resposta (200 · JSON)

Campo	Tipo	Significado
`[].id`	identificador (UUID)	Identificador único (UUID).
`[].data`	data e hora (ISO 8601)	A data e hora (UTC).
`[].tipo`	texto
`[].categoria`	texto
`[].valor`	número	O valor.
`[].metodoPagamentoDescricao`	texto ou nulo
`[].documento`	texto ou nulo

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/conciliacao/<contaId>/movimentos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/financeiro/conciliacao/{contaId}#

Concilia uma conta: marca como conferidos os movimentos que batem com o extracto do banco.

Permissão Financeiro.ConciliacaoRegistar
Idempotência aceita Idempotency-Key

Leva dataExtracto, saldoExtracto e os movimentoIds conferidos (e uma observacao, opcional). O saldo do extracto tem de ser igual ao saldo conciliado antes mais os movimentos marcados (diferença zero).

Só se concilia para a frente: o dia do extracto é posterior ao da conciliação anterior, e não pode estar no futuro. Devolve o id da conciliação.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`contaId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ConciliarRequest)

Campo	Tipo	Obrigatório	Significado
`dataExtracto`	data (AAAA-MM-DD)	sim
`saldoExtracto`	número	sim
`movimentoIds`	lista de identificador (UUID)	sim
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/conciliacao/<contaId>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "dataExtracto": "2026-10-12",
  "saldoExtracto": 0,
  "movimentoIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

POST/api/financeiro/conciliacao/desfazer/{id}#

Desfaz a conciliação mais recente de uma conta: os movimentos voltam a ficar por conciliar.

Permissão Financeiro.ConciliacaoRegistar
Idempotência aceita Idempotency-Key

Exige o motivo, que fica na trilha. Só se desfaz a mais recente: desfaça primeiro as posteriores.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DesfazerConciliacaoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/conciliacao/desfazer/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'

GET/api/financeiro/periodos#

Os períodos financeiros: até quando a contabilidade está fechada.

Permissão Financeiro.ContasLer

Resposta (200 · JSON)

Campo	Tipo	Significado
`fechadoAte`	data (AAAA-MM-DD) ou nulo
`ultimoFechavel`	data (AAAA-MM-DD)
`proximoAFechar`	data (AAAA-MM-DD) ou nulo
`historico`	lista de objectos
`historico[].id`	identificador (UUID)	Identificador único (UUID).
`historico[].sequencia`	número inteiro
`historico[].tipo`	texto
`historico[].fechadoAte`	data (AAAA-MM-DD) ou nulo
`historico[].fechadoAteAnterior`	data (AAAA-MM-DD) ou nulo
`historico[].motivo`	texto ou nulo
`historico[].realizadoPorNome`	texto ou nulo
`historico[].realizadoEmUtc`	data e hora (ISO 8601)

Pedido

curl

curl 'https://<endereço-da-API>/api/financeiro/periodos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/financeiro/periodos/fechar#

Fecha um mês: depois de fechado, nada se lança nem se estorna nesse mês.

Permissão Financeiro.PeriodosFechar
Idempotência aceita Idempotency-Key

Indique em ate o último dia de um mês já terminado: fecham-se os meses até aí.

Recusa-se enquanto houver despesas recorrentes com ciclos por lançar nesses meses (lançam-se primeiro, ou cancelam-se). Fica registado quem fechou e quando.

Corpo do pedido (JSON · FecharPeriodoRequest)

Campo	Tipo	Obrigatório
`ate`	data (AAAA-MM-DD)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/periodos/fechar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "ate": "2026-10-12"
}'

POST/api/financeiro/periodos/reabrir#

Reabre um mês fechado, com o motivo.

Permissão Financeiro.PeriodosReabrir
Idempotência aceita Idempotency-Key

É um acto sensível: o motivo é obrigatório e fica na trilha com o nome de quem reabriu. ate é o último dia que deve continuar fechado; sem ele, reabre tudo. Reabrir permite lançar em meses cujos mapas já podem ter sido entregues.

Corpo do pedido (JSON · ReabrirPeriodoRequest)

Campo	Tipo	Obrigatório
`ate`	data (AAAA-MM-DD) ou nulo
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/financeiro/periodos/reabrir' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'