Skip to content
Documentação
/
Baixas
/
Baixas
/
Cria uma baixa

Baixas (v1)

API para gerenciamento de baixas.

Download OpenAPI description
acquittance-apis-openapi.json
acquittance-apis-openapi.yaml
Languages
Servers
Servidor de produção.

https://api-v2.contaazul.com/

Mock server

https://developers.contaazul.com/_mock/docs/acquittance-apis-openapi/

Baixas

Operações relacionadas ao gerenciamento de baixas

Operations

Cria uma baixa

Request

Cria uma baixa para uma parcela específica.

Security
bearerAuth
Path
parcela_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
Bodyapplication/jsonrequired
data_pagamentostring(date)required

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject(ValorComposicaoDTO)required
composicao_valor.​multanumber(double)

Valor da multa, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​jurosnumber(double)

Valor dos juros, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​valor_brutonumber(double)required

Valor bruto, deve ser informado e maior ou igual a zero.

Example: 1000
composicao_valor.​descontonumber(double)

Valor do desconto, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​taxanumber(double)

Valor da taxa, deve ser maior ou igual a zero.

Example: 0
conta_financeirastring(uuid)required

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Pagamento referente à fatura #1234."
nsustring

Número sequencial único.

Example: "1234567890"
curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b/baixa \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_pagamento": "2023-10-01",
    "composicao_valor": {
      "multa": 0,
      "juros": 0,
      "valor_bruto": 1000,
      "desconto": 0,
      "taxa": 0
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Pagamento referente à fatura #1234.",
    "nsu": "1234567890"
  }'

Responses

Baixa criada com sucesso.

Bodyapplication/json
idstring(uuid)

Identificador único gerado automaticamente após a criação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject(ValorComposicaoDTO)
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Pagamento referente à fatura #1234."
nsustring

Número sequencial único.

Example: "1234567890"
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "composicao_valor": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Pagamento referente à fatura #1234.",
  "nsu": "1234567890"
}

Lista baixas

Request

Lista todas as baixas associadas ao UUID da parcela.

Security
bearerAuth
Path
parcela_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b/baixa \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de baixas retornada com sucesso.

Bodyapplication/jsonArray [
idstring(uuid)

Identificador único da baixa.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
valor_composicaoobject(ValorComposicaoDTO)
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_reconciliacaostring(uuid)

Identificador único da reconciliação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_parcelastring(uuid)

Identificador único da parcela.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_solicitacao_cobrancastring(uuid)

Identificador único da solicitação de cobrança.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
observacaostring

Observação.

Example: "Pagamento referente à fatura #1234."
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
origemstring

Origem.

Enum"LANCAMENTO_FINANCEIRO""DAS""FOLHA""TRANSFERENCIA""SALDO_CONTA_BANCARIA""VENDA""COMPRA""VENDA_AGENDADA""COMPRA_AGENDADA""IMPORTACAO_DOCUMENTO"
Example: "SALDO_CONTA_BANCARIA"
id_recibo_digitalstring(uuid)

Identificador único do recibo digital.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
tipo_evento_financeirostring

Tipo de evento financeiro.

Enum"RECEITA""DESPESA"
Example: "RECEITA"
nsustring

Número sequencial único.

Example: "1234567890"
id_referenciastring

Identificador único da referência.

Example: "REF1234"
atualizado_emstring(date-time)

Data de atualização.

Example: "2023-10-01T12:00:00Z"
anexosArray of objects(AnexoBaixaResponseDTO)
]
Response
application/json
[
  {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "versao": 1,
    "data_pagamento": "2023-10-01",
    "valor_composicao": { … },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_reconciliacao": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_parcela": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "observacao": "Pagamento referente à fatura #1234.",
    "metodo_pagamento": "CARTAO_CREDITO",
    "origem": "SALDO_CONTA_BANCARIA",
    "id_recibo_digital": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "tipo_evento_financeiro": "RECEITA",
    "nsu": "1234567890",
    "id_referencia": "REF1234",
    "atualizado_em": "2023-10-01T12:00:00Z",
    "anexos": [ … ]
  }
]

Atualiza uma baixa

Request

Atualiza os dados de uma baixa existente.

Security
bearerAuth
Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
Bodyapplication/jsonrequired
versaointeger(int64)required

Versão atual do registro. Este valor será incrementado após sucesso na atualização.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject(ValorComposicaoDTO)
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação adicional.

Example: "Payment for invoice #1234"
nsustring

Número sequencial único.

Example: "1234567890"
curl -i -X PATCH \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/baixas/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "versao": 1,
    "data_pagamento": "2023-10-01",
    "composicao_valor": {
      "multa": 0,
      "juros": 0,
      "valor_bruto": 1000,
      "desconto": 0,
      "taxa": 0
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Payment for invoice #1234",
    "nsu": "1234567890"
  }'

Responses

Baixa atualizada com sucesso.

Bodyapplication/json
idstring(uuid)

Identificador único gerado automaticamente após a criação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject(ValorComposicaoDTO)
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Pagamento referente à fatura #1234."
nsustring

Número sequencial único.

Example: "1234567890"
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "composicao_valor": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Pagamento referente à fatura #1234.",
  "nsu": "1234567890"
}

Remove uma baixa

Request

Remove uma baixa pelo UUID fornecido.

Security
bearerAuth
Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X DELETE \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/baixas/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Baixa removida com sucesso.

Busca uma baixa

Request

Retorna os detalhes de uma baixa pelo UUID fornecido.

Security
bearerAuth
Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/baixas/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Detalhes da baixa retornados com sucesso.

Bodyapplication/json
idstring(uuid)

Identificador único da baixa.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
valor_composicaoobject(ValorComposicaoDTO)
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_reconciliacaostring(uuid)

Identificador único da reconciliação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_parcelastring(uuid)

Identificador único da parcela.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_solicitacao_cobrancastring(uuid)

Identificador único da solicitação de cobrança.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
observacaostring

Observação.

Example: "Pagamento referente à fatura #1234."
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
origemstring

Origem.

Enum"LANCAMENTO_FINANCEIRO""DAS""FOLHA""TRANSFERENCIA""SALDO_CONTA_BANCARIA""VENDA""COMPRA""VENDA_AGENDADA""COMPRA_AGENDADA""IMPORTACAO_DOCUMENTO"
Example: "SALDO_CONTA_BANCARIA"
id_recibo_digitalstring(uuid)

Identificador único do recibo digital.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
tipo_evento_financeirostring

Tipo de evento financeiro.

Enum"RECEITA""DESPESA"
Example: "RECEITA"
nsustring

Número sequencial único.

Example: "1234567890"
id_referenciastring

Identificador único da referência.

Example: "REF1234"
atualizado_emstring(date-time)

Data de atualização.

Example: "2023-10-01T12:00:00Z"
anexosArray of objects(AnexoBaixaResponseDTO)
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "valor_composicao": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_reconciliacao": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_parcela": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "observacao": "Pagamento referente à fatura #1234.",
  "metodo_pagamento": "CARTAO_CREDITO",
  "origem": "SALDO_CONTA_BANCARIA",
  "id_recibo_digital": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "tipo_evento_financeiro": "RECEITA",
  "nsu": "1234567890",
  "id_referencia": "REF1234",
  "atualizado_em": "2023-10-01T12:00:00Z",
  "anexos": [
    { … }
  ]
}