Skip to content
API/
Financeiro
/
/v1

v1

Conjunto de recursos para acompanhar e administrar operações relacionadas a cobranças - esses recursos incluem retornar a cobrança por id, deletar cobrança por id e criar uma nova cobrança

Operations

Retornar a cobrança por id

Request

Permite consultar os detalhes de uma cobrança específica utilizando seu identificador único (id_cobranca).

Security
BearerAuth
Path
id_cobrancastring, (uuid)required

Identificador único da cobrança

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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