Skip to content

Protocolos (v1)

A API de Protocolos é responsável por gerenciar o ciclo de vida de eventos enviados ao ERP, permitindo que sua aplicação acompanhe o processamento do evento financeiro. Quando um evento financeiro é enviado para a Conta Azul, ele gera um protocolo, que funciona como um identificador único para acompanhar o status dessa operação.

Essa API é essencial para integrações assíncronas, em que o evento não é processado imediatamente. Em vez disso, o ERP recebe a solicitação, coloca em fila e atualiza o status conforme o processamento avança.

API descontinuada em 18/10/2026. A partir dessa data a API de Protocolos deixa de existir. A criação de contas a pagar e a receber (POST /v1/financeiro/eventos-financeiros/contas-a-pagar e POST /v1/financeiro/eventos-financeiros/contas-a-receber) deixa de retornar o protocolo: a resposta já traz a conta criada, com o id, e os erros voltam na própria resposta, com HTTP 4xx. Remova da sua integração as chamadas a GET /v1/protocolo/{id} até 18/10/2026.

Languages
Servers
https://api-v2.contaazul.com
Mock server
https://developers.contaazul.com/_mock/docs/protocol-apis-openapi