Retornar as baixas pelo id da parcela

v1
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

Operations

Criar uma nova 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: 5

composicao_valor.jurosnumber(double)

Valor dos juros, deve ser maior ou igual a zero

Example: 2.5

composicao_valor.valor_brutonumber(double)required

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

Example: 150

composicao_valor.descontonumber(double)

Valor do desconto, deve ser maior ou igual a zero

Example: 10

composicao_valor.taxanumber(double)

Valor da taxa, deve ser maior ou igual a zero

Example: 3.75

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": 5,
      "juros": 2.5,
      "valor_bruto": 150,
      "desconto": 10,
      "taxa": 3.75
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Pagamento referente à fatura #1234.",
    "nsu": "1234567890"
  }'

Responses

OK

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": 5,
    "juros": 2.5,
    "valor_bruto": 150,
    "desconto": 10,
    "taxa": 3.75
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Pagamento referente à fatura #1234.",
  "nsu": "1234567890"
}

Retornar as baixas pelo id da parcela

Request

Lista todas as baixas associadas ao id 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

OK

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": [ … ]
  }
]

Atualizar parcialmente uma baixa por id

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: "Pagamento referente à fatura #1234."

nsustring

Número sequencial único

Example: "1234567890"

curl -i -X PATCH \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/baixa/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": 5,
      "juros": 2.5,
      "valor_bruto": 150,
      "desconto": 10,
      "taxa": 3.75
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Pagamento referente à fatura #1234.",
    "nsu": "1234567890"
  }'

Responses

OK

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": 5,
    "juros": 2.5,
    "valor_bruto": 150,
    "desconto": 10,
    "taxa": 3.75
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Pagamento referente à fatura #1234.",
  "nsu": "1234567890"
}

Deletar baixa por id

Request

Remove uma baixa pelo id 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/parcelas/baixa/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Retornar a baixa por id

Request

Retorna os detalhes de uma baixa pelo id 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/parcelas/baixa/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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": 5,
    "juros": 2.5,
    "valor_bruto": 150,
    "desconto": 10,
    "taxa": 3.75
  },
  "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": [
    { … }
  ]
}

Baixas (v1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

v1
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Criar uma nova baixa

Request

Responses

Was this helpful?

Retornar as baixas pelo id da parcela

Request

Responses

Was this helpful?

Atualizar parcialmente uma baixa por id

Request

Responses

Was this helpful?

Deletar baixa por id

Request

Responses

Was this helpful?

Retornar a baixa por id

Request

Responses

Was this helpful?

Baixas (v1)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

v1CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Criar uma nova baixa

RequestExpand all

Responses

Was this helpful?

Retornar as baixas pelo id da parcela

Request

Responses

Was this helpful?

Atualizar parcialmente uma baixa por id

RequestExpand all

Responses

Was this helpful?

Deletar baixa por id

Request

Responses

Was this helpful?

Retornar a baixa por id

Request

Responses

Was this helpful?

Baixas (v1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

v1
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request