# Baixas

A API de Baixas tem como objetivo automatizar e simplificar o processo de conciliação financeira, permitindo o registro e o acompanhamento de pagamentos recebidos. Com ela, é possível criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa, deletar uma baixa e retornar a baixa, garantindo que o status financeiro das cobranças seja atualizado de maneira precisa e em tempo real, reduzindo o retrabalho e evitando inconsistências entre sistemas.

Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:

**Lançamentos Financeiros:**  
[https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar)


Version: v1

## Servers

Servidor de produção
```
https://api-v2.contaazul.com
```

## Security

### BearerAuth

Token de autorização Bearer JWT

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Baixas](https://developers.contaazul.com/_bundle/docs/acquittance-apis-openapi.yaml)

## v1

Conjunto de recursos para acompanhar e administrar operações relacionadas ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa por id, deletar baixa por id e retornar a baixa por id

### Criar uma nova baixa

 - [POST /v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa](https://developers.contaazul.com/docs/acquittance-apis-openapi/v1/criarbaixa.md): Permite registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada.

### Retornar as baixas pelo id da parcela

 - [GET /v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa](https://developers.contaazul.com/docs/acquittance-apis-openapi/v1/listarbaixas.md): Permite consultar todas as baixas associadas a uma determinada parcela. Essa funcionalidade possibilita o acompanhamento detalhado de pagamentos realizados, facilitando a auditoria e o controle financeiro.

### Atualizar parcialmente uma baixa por id

 - [PATCH /v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}](https://developers.contaazul.com/docs/acquittance-apis-openapi/v1/atualizarbaixa.md): Permite atualizar parcialmente as informações de uma baixa. Use a baixa parcial quando houver pagamento ou recebimento parcial de uma fatura, seja por negociação com cliente/fornecedor ou em situações de inadimplência parcial. Por meio desse endpoint, é possível corrigir dados como valor, conta financeira, data de pagamento ou observações, mantendo o controle de versão para evitar conflitos de atualização.

### Deletar baixa por id

 - [DELETE /v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}](https://developers.contaazul.com/docs/acquittance-apis-openapi/v1/deletarbaixa.md): Permite excluir uma baixa existente do sistema. Esse endpoint deve ser utilizado com cautela, pois a exclusão impacta diretamente o saldo e o histórico financeiro da parcela associada.

### Retornar a baixa por id

 - [GET /v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}](https://developers.contaazul.com/docs/acquittance-apis-openapi/v1/buscarbaixa.md): Permite consultar os detalhes de uma baixa específica a partir do seu identificador único (baixa_id). O retorno inclui informações completas sobre a baixa, como data de pagamento, valores envolvidos, conta financeira utilizada, método de pagamento e observações registradas.