Skip to content

v1

Recurso para acompanhar e administrar operações relacionadas a protocolos — esse recurso inclui retornar o protocolo por id

Operations

Descontinuado em 18/10/2026
Retornar o protocolo por id (descontinuado)
deprecated

Request

Descontinuado em 18/10/2026. Este endpoint deixa de existir. A criação de contas a pagar e a receber deixa de retornar protocolo: leia o id direto da resposta do POST /v1/financeiro/eventos-financeiros/contas-a-pagar ou POST /v1/financeiro/eventos-financeiros/contas-a-receber.

Permite consultar os detalhes de um protocolo específico identificado por id.

Security
BearerAuth
Path
idstring, (uuid)required
Example:123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  https://api-v2.contaazul.com/v1/protocolo/123e4567-e89b-12d3-a456-426614174000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring, (uuid)

Identificador do protocolo

Example:"123e4567-e89b-12d3-a456-426614174000"
respostastring

Mensagem do protocolo

Example:"Operação realizada com sucesso."
statusstring

Status do protocolo: - PENDING: em processamento - SUCCESS: criado - ERROR: erro na criação

Enum:"PENDING""SUCCESS""ERROR"
Example:"SUCCESS"
evento_financeiro_idstring, (uuid)

Identificador do evento financeiro

Example:"123e4567-e89b-12d3-a456-426614174000"
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "resposta": "Operação realizada com sucesso.",
  "status": "SUCCESS",
  "evento_financeiro_id": "123e4567-e89b-12d3-a456-426614174000"
}