{"items":[{"type":"link","label":"Protocolos","link":"/docs/protocol-apis-openapi","routeSlug":"/docs/protocol-apis-openapi","content":{"contentType":"overview","meta":{"name":"Protocolos"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"protocol-apis-openapi.json","url":"/_bundle/docs/protocol-apis-openapi.json?download"},{"kind":"download","label":"protocol-apis-openapi.yaml","url":"/_bundle/docs/protocol-apis-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/protocol-apis-openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Protocolos (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API descontinuada em 18/10/2026."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A partir dessa data a API de Protocolos deixa de existir. A criação de contas a pagar e a receber ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/financeiro/eventos-financeiros/contas-a-pagar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/financeiro/eventos-financeiros/contas-a-receber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") deixa de retornar o protocolo: a resposta já traz a conta criada, com o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e os erros voltam na própria resposta, com HTTP 4xx. Remova da sua integração as chamadas a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/protocolo/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" até 18/10/2026."},"children":[]}]}]}]}]}],"sectionId":"/docs/protocol-apis-openapi"}],"sectionId":"/docs/protocol-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/protocol-apis-openapi/v1","routeSlug":"/docs/protocol-apis-openapi/v1","items":[{"label":"Retornar o protocolo por id (descontinuado)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/protocol-apis-openapi/v1/buscarprotocoloporid","routeSlug":"/docs/protocol-apis-openapi/v1/buscarprotocoloporid","metadata":{"seo":{"title":"Retornar o protocolo por id (descontinuado)","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buscarProtocoloPorId","name":"Retornar o protocolo por id (descontinuado)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1protocolo~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o protocolo por id (descontinuado)","badges":[{"name":"Descontinuado em 18/10/2026","color":"#D92D20","position":"before"}],"isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descontinuado em 18/10/2026."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Este endpoint deixa de existir. A criação de contas a pagar e a receber deixa de retornar protocolo: leia o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" direto da resposta do "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/financeiro/eventos-financeiros/contas-a-pagar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ou "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/financeiro/eventos-financeiros/contas-a-receber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os detalhes de um protocolo específico identificado por id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v1~1protocolo~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/protocolo/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/protocol-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/protocolo/{id}","href":"v1/buscarprotocoloporid","openApiOperationId":"buscarProtocoloPorId","summary":"Retornar o protocolo por id (descontinuado)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/protocol-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}},"schemaId":"components/schemas/ProtocolResponseDTO"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1protocolo~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProtocolResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/buscarprotocoloporid"}],"panels":[]}]},"badges":[{"name":"Descontinuado em 18/10/2026","color":"#D92D20","position":"before"}],"httpPath":"/v1/protocolo/{id}"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurso para acompanhar e administrar operações relacionadas a protocolos —  esse recurso inclui retornar o protocolo por id"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/protocolo/{id}","summary":"Retornar o protocolo por id (descontinuado)","prefix":{"name":"get","color":"http-deprecated"},"badges":[{"name":"Descontinuado em 18/10/2026","color":"#D92D20","position":"before"}],"link":"/v1/buscarprotocoloporid","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ProtocolResponseDTO":{"id":"components/schemas/ProtocolResponseDTO","kind":"json-schema","title":"ProtocolResponseDTO","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identificador do protocolo","example":"123e4567-e89b-12d3-a456-426614174000"},"resposta":{"type":"string","description":"Mensagem do protocolo","example":"Operação realizada com sucesso."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status do protocolo: - PENDING: em processamento - SUCCESS: criado - ERROR: erro na criação"},"children":[]}]}]}],"enum":["PENDING","SUCCESS","ERROR"],"example":"SUCCESS"},"evento_financeiro_id":{"type":"string","format":"uuid","description":"Identificador do evento financeiro","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_0"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/protocol-apis-openapi","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/docs/protocol-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/protocol-apis-openapi.json?download"},{"url":"/_bundle/docs/protocol-apis-openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Protocolos","description":"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.\n\nEssa 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.\n\n> **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.\n"}},"baseSlug":"/docs/protocol-apis-openapi","routesMapping":{}}