Cobranças

API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developers.contaazul.com/_mock/openapi/
Servidor de produção
https://api-public.contaazul.com/

Autenticação

Operations

Cobranças

Operations

Buscar cobrança por ID

Request

Retorna os detalhes de uma cobrança específica pelo ID.

Path
id_cobrancastring(uuid)required

Identificador único da cobrança.

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cobrança encontrada com sucesso

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
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "url": "http://www.exemplo.com.br",
  "status": "AGUARDANDO_CONFIRMACAO"
}

Cancelar cobrança por ID

Request

Cancela uma cobrança específica pelo ID.

Path
id_cobrancastring(uuid)required

Identificador único da cobrança.

curl -i -X DELETE \
  'https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cobrança cancelada com sucesso

Geração de cobrança

Request

Gera uma cobrança

Bodyapplication/jsonrequired
conta_bancariastring(uuid)required

Identificador único para a conta bancária.

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

Descrição da fatura.

Example: "Payment for invoice #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"
atributosobjectrequired
atributos.​desconto_antecipadoobject
curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "conta_bancaria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "descricao_fatura": "Payment for invoice #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
      }
    }
  }'

Responses

Cobrança gerada com sucesso

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
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "url": "http://www.exemplo.com.br",
  "status": "AGUARDANDO_CONFIRMACAO"
}

Contratos

Operations

Centro de Custo

Operations

Categorias

Operations

Conta Financeira

Operations

Financeiro

Operations

Produto

Operations

Cadastro de Pessoas

Operations

Protocolo

Operations

Venda

Operations

Serviço

Operations