Skip to content
/
Retornar as baixas pelo i...

Retornar as baixas pelo id da parcela

Request

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.

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/json
Array [
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
[
  {
    "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": [ … ]
  }
]