API///
- Financeiro
- Cobranças
- Criar uma nova cobrança
Retornar a cobrança por id
Deletar cobrança por id
Criar uma nova cobrança
Permite criar uma nova cobrança, por meio desse endpoint, é possível informar o valor, data de vencimento, descrição da fatura e demais parâmetros que definem a cobrança. Essa funcionalidade facilita a geração automatizada de cobranças.
Security
BearerAuth
Identificador único para a conta bancária. A conta deve ser do tipo "COBRANCAS_CONTA_AZUL" ou, caso seja uma Conta PJ Conta Azul, do tipo "CONTA_CORRENTE"
Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"
Identificador único para a parcela
Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"
Tipo da cobrança
Enum:"LINK_PAGAMENTO""PIX_COBRANCA""BOLETO"
Example:"LINK_PAGAMENTO"
- https://api-v2.contaazul.comhttps://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca
- Mock serverhttps://developers.contaazul.com/_mock/docs/charge-apis-openapi/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca
curl -i -X POST \
https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"conta_bancaria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
"descricao_fatura": "Pagamento da fatura #1234",
"id_parcela": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
"data_vencimento": "2023-10-10",
"tipo": "LINK_PAGAMENTO",
"atributos": {
"desconto_antecipado": {
"valor": 10,
"percentual": 10,
"dias_antes_vencer": 10
}
},
"maximo_parcelas": 3
}'OK
Response
{ "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b", "url": "http://www.exemplo.com.br", "status": "AGUARDANDO_CONFIRMACAO" }