Criar uma nova cobrança

Request

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

Bodyapplication/jsonrequired

conta_bancariastring, (uuid)required

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"

descricao_faturastringrequired

Descrição da fatura

Example:"Pagamento da fatura #1234"

id_parcelastring, (uuid)required

Identificador único para a parcela

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

data_vencimentostring, (date)required

Data de vencimento da cobrança

Example:"2023-10-10"

tipostringrequired

Tipo da cobrança

Enum:"LINK_PAGAMENTO""PIX_COBRANCA""BOLETO"

Example:"LINK_PAGAMENTO"

atributosobject(GerarCobrancaRequestAtributosDto)

maximo_parcelasinteger

Número máximo de parcelas exibido na fatura do cartão

Example:3

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
  }'

Responses

OK

Bodyapplication/json

idstring, (uuid)

Identificador único da cobrança

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

urlstring

URL da cobrança

Example:"http://www.exemplo.com.br"

statusstring

Status da cobrança

Enum:"AGUARDANDO_CONFIRMACAO""EM_CANCELAMENTO""REGISTRADO""QUITADO""CANCELADO""INVALIDO""EXPIRADO""FALHA_EMISSAO""FALHA_CANCELAR""REMESSA_GERADO"

Example:"AGUARDANDO_CONFIRMACAO"

Response

{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "url": "http://www.exemplo.com.br",
  "status": "AGUARDANDO_CONFIRMACAO"
}