{"items":[{"type":"link","label":"Captura","link":"/open-api-docs/developer-platform-open-api-capture","routeSlug":"/open-api-docs/developer-platform-open-api-capture","content":{"contentType":"overview","meta":{"name":"Captura"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"developer-platform-open-api-capture.json","url":"/_bundle/open-api-docs/developer-platform-open-api-capture.json?download"},{"kind":"download","label":"developer-platform-open-api-capture.yaml","url":"/_bundle/open-api-docs/developer-platform-open-api-capture.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/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Captura (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":"Operações relacionadas à captura de documentos"},"children":[]}]}]}]}],"sectionId":"/open-api-docs/developer-platform-open-api-capture"}],"sectionId":"/open-api-docs/developer-platform-open-api-capture"}]}]}},{"type":"group","label":"v1","link":"/open-api-docs/developer-platform-open-api-capture/v1","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1","items":[{"label":"Envia um documento para a captura e extração de dados","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/uploadarquivoscapturadocumentos","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/uploadarquivoscapturadocumentos","metadata":{"seo":{"title":"Envia um documento para a captura e extração de dados","description":"Recebe um arquivo (PDF, JPEG, PNG ou BMP; máximo de 10 MB) via multipart/form-data e o encaminha para a extração automática de dados. Retorna o identificador do documento a ser processado, utilizado para consultar o status do processamento posteriormente."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadArquivosCapturaDocumentos","name":"Envia um documento para a captura e extração de dados","isWebhook":false,"pointer":"/paths/~1v1~1captura~1documentos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Envia um documento para a captura e extração de dados","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recebe um arquivo (PDF, JPEG, PNG ou BMP; máximo de 10 MB) via multipart/form-data e o encaminha para a extração automática de dados. Retorna o identificador do documento a ser processado, utilizado para consultar o status do processamento posteriormente."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_236"}},"schemaId":"schema_236","pointer":"/paths/~1v1~1captura~1documentos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/captura/documentos","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_236"}},"responseCodes":["201","400","401","415","429","500","502","503","504"],"pointer":"/v1/captura/documentos","href":"v1/uploadarquivoscapturadocumentos","openApiOperationId":"uploadArquivosCapturaDocumentos","summary":"Envia um documento para a captura e extração de dados"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"schemaId":"schema_236","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_236"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Documento aceito para captura","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoEnvioDocumentoCaptura"}},"schemaId":"components/schemas/ResumoEnvioDocumentoCaptura"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arquivo ausente/vazio, acima do tamanho máximo ou descrição inválida"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autenticado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"415","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formato não suportado ou divergente do conteúdo do arquivo"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Excesso de requisições"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"500","description":"Erro interno","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"502","description":"Falha ao processar o documento","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Serviço temporariamente indisponível"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"},{"code":"504","description":"Tempo de processamento excedido","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}},"schemaId":"components/schemas/http.Error"}],"pointer":"/paths/~1v1~1captura~1documentos/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResumoEnvioDocumentoCaptura","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoEnvioDocumentoCaptura"}}},{"code":"400","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"401","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"415","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"429","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"500","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"502","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"503","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}},{"code":"504","schemaId":"components/schemas/http.Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/http.Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/uploadarquivoscapturadocumentos"}],"panels":[]}]},"httpPath":"/v1/captura/documentos"},{"label":"Consulta o status de documentos e das extrações (Captura)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/consultastatusdocumentoscaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/consultastatusdocumentoscaptura","metadata":{"seo":{"title":"Consulta o status de documentos e das extrações (Captura)","description":"Consulta, para um ou mais documentos enviados à IA Captura, o status do processamento do documento e o status da captura (extração) gerada a partir dele. Um documento pode ser processado sem gerar captura — nesse caso, os campos da captura retornam vazios. Como o processamento é assíncrono, a orientação é consultar periodicamente (polling) até que os status cheguem a um estado final."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consultaStatusDocumentosCaptura","name":"Consulta o status de documentos e das extrações (Captura)","isWebhook":false,"pointer":"/paths/~1v1~1captura~1documentos~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consulta o status de documentos e das extrações (Captura)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consulta, para um ou mais documentos enviados à IA Captura, o status do processamento do documento e o status da captura (extração) gerada a partir dele. Um documento pode ser processado sem gerar captura — nesse caso, os campos da captura retornam vazios. Como o processamento é assíncrono, a orientação é consultar periodicamente (polling) até que os status cheguem a um estado final."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_237","description":"IDs dos documentos a serem consultados (máximo 20)","required":true},{"name":"pagina","in":"query","schemaId":"schema_238","description":"Número da página (padrão 1)"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_238","description":"Tamanho da página (padrão 10, máximo 20)"}],"pointer":"/paths/~1v1~1captura~1documentos~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/captura/documentos/status","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":true,"schemaId":"schema_237","style":"form","explode":false},{"name":"pagina","in":"query","schemaId":"schema_238"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_238"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/captura/documentos/status","href":"v1/consultastatusdocumentoscaptura","openApiOperationId":"consultaStatusDocumentosCaptura","summary":"Consulta o status de documentos e das extrações (Captura)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","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/DocumentStatusResume"}},"schemaId":"components/schemas/DocumentStatusResume"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida — dados de entrada incorretos (ex.: ids vazio, UUID inválido ou tamanho_pagina acima de 20)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autenticado — token de acesso ausente ou inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro interno ao consultar o status no serviço da Captura"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1captura~1documentos~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentStatusResume","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentStatusResume"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/consultastatusdocumentoscaptura"}],"panels":[]}]},"httpPath":"/v1/captura/documentos/status"},{"label":"Consulta os dados extraídos da captura do documento enviado","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/consultadadosextraidoscaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/consultadadosextraidoscaptura","metadata":{"seo":{"title":"Consulta os dados extraídos da captura do documento enviado","description":"Retorna os dados que a IA Captura extraiu do documento e a sugestão de evento financeiro associada. O envio do documento em POST /v1/captura/documentos devolve o id do documento; com ele, a consulta em GET /v1/captura/documentos/status devolve o id_captura; e é esse id_captura que identifica a captura consultada aqui. A prévia do evento financeiro (previa_evento_financeiro) e a sugestão (sugestao_evento_financeiro) são retornadas apenas quando o status da captura é PENDENTE; nos demais estados (PROCESSANDO, ACEITA, REJEITADA, FALHA) a resposta traz somente id, id_documento e status. Recomenda-se, portanto, consultar este endpoint quando o status já indicar que os dados de extração estão disponíveis (PENDENTE)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consultaDadosExtraidosCaptura","name":"Consulta os dados extraídos da captura do documento enviado","isWebhook":false,"pointer":"/paths/~1v1~1captura~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consulta os dados extraídos da captura do documento enviado","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna os dados que a IA Captura extraiu do documento e a sugestão de evento financeiro associada. O envio do documento em POST /v1/captura/documentos devolve o id do documento; com ele, a consulta em GET /v1/captura/documentos/status devolve o id_captura; e é esse id_captura que identifica a captura consultada aqui. A prévia do evento financeiro (previa_evento_financeiro) e a sugestão (sugestao_evento_financeiro) são retornadas apenas quando o status da captura é PENDENTE; nos demais estados (PROCESSANDO, ACEITA, REJEITADA, FALHA) a resposta traz somente id, id_documento e status. Recomenda-se, portanto, consultar este endpoint quando o status já indicar que os dados de extração estão disponíveis (PENDENTE)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_239","description":"ID da captura a ser consultada","required":true}],"pointer":"/paths/~1v1~1captura~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/captura/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/captura/{id}","href":"v1/consultadadosextraidoscaptura","openApiOperationId":"consultaDadosExtraidosCaptura","summary":"Consulta os dados extraídos da captura do documento enviado"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dados extraídos da captura"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Captura"}},"schemaId":"components/schemas/Captura"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida — o ID da captura informado não é um UUID válido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autenticado — token de acesso ausente ou inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captura não encontrada com o ID informado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Erro interno ao consultar os dados da captura","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1captura~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Captura","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Captura"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/consultadadosextraidoscaptura"}],"panels":[]}]},"httpPath":"/v1/captura/{id}"},{"label":"Aceita a prévia do evento financeiro da captura","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/aceitarpreviacaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/aceitarpreviacaptura","metadata":{"seo":{"title":"Aceita a prévia do evento financeiro da captura","description":"Confirma a prévia sugerida pela IA Captura e cria o evento financeiro correspondente na Conta Azul. A requisição não possui corpo — o aceite usa apenas o id_captura da rota, obtido na consulta de status. Retorna os dados do evento financeiro criado."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"aceitarPreviaCaptura","name":"Aceita a prévia do evento financeiro da captura","isWebhook":false,"pointer":"/paths/~1v1~1captura~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aceita a prévia do evento financeiro da captura","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirma a prévia sugerida pela IA Captura e cria o evento financeiro correspondente na Conta Azul. A requisição não possui corpo — o aceite usa apenas o id_captura da rota, obtido na consulta de status. Retorna os dados do evento financeiro criado."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_239","description":"ID da captura cuja prévia será aceita","required":true}],"pointer":"/paths/~1v1~1captura~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/captura/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","409","422","500","502","503","504"],"pointer":"/v1/captura/{id}","href":"v1/aceitarpreviacaptura","openApiOperationId":"aceitarPreviaCaptura","summary":"Aceita a prévia do evento financeiro da captura"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prévia aceita; o evento financeiro é omitido quando a captura já estava aceita"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CapturaAceita"}},"schemaId":"components/schemas/CapturaAceita"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida — o ID da captura informado não é um UUID válido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autenticado — token de acesso ausente ou inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captura não encontrada com o ID informado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A captura não pode ser aceita no status atual"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não foi possível criar o lançamento financeiro a partir da captura"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro interno ao aceitar a prévia da captura"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Falha ao processar a solicitação no serviço da Captura"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Serviço temporariamente indisponível"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"504","description":"Tempo de processamento excedido","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1captura~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CapturaAceita","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CapturaAceita"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"409","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"422","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"502","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"503","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"504","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/aceitarpreviacaptura"}],"panels":[]}]},"httpPath":"/v1/captura/{id}"},{"label":"Recusa a captura (rejeita o evento financeiro sugerido)","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/recusacaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/recusacaptura","metadata":{"seo":{"title":"Recusa a captura (rejeita o evento financeiro sugerido)","description":"Recusa a prévia do evento financeiro sugerido pela IA Captura para a captura informada, identificada pelo id_captura obtido em GET /v1/captura/documentos/status. Uma captura que já foi aceita ou que ainda está em processamento não pode ser recusada. Após a recusa, a captura deixa de ser retornada na consulta de status; se todas as capturas do documento forem recusadas, o próprio documento também deixa de ser listado."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recusaCaptura","name":"Recusa a captura (rejeita o evento financeiro sugerido)","isWebhook":false,"pointer":"/paths/~1v1~1captura~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recusa a captura (rejeita o evento financeiro sugerido)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recusa a prévia do evento financeiro sugerido pela IA Captura para a captura informada, identificada pelo id_captura obtido em GET /v1/captura/documentos/status. Uma captura que já foi aceita ou que ainda está em processamento não pode ser recusada. Após a recusa, a captura deixa de ser retornada na consulta de status; se todas as capturas do documento forem recusadas, o próprio documento também deixa de ser listado."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_239","description":"ID da captura a ser recusada","required":true}],"pointer":"/paths/~1v1~1captura~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/captura/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/captura/{id}","href":"v1/recusacaptura","openApiOperationId":"recusaCaptura","summary":"Recusa a captura (rejeita o evento financeiro sugerido)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","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":"204","description":"Captura recusada com sucesso"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requisição inválida — o ID da captura informado não é um UUID válido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Não autenticado — token de acesso ausente ou inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captura não encontrada com o ID informado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A captura não pode ser recusada no status atual (já foi aceita ou está em processamento)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Erro interno ao recusar a captura","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1captura~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"409","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/recusacaptura"}],"panels":[]}]},"httpPath":"/v1/captura/{id}"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/captura/documentos","summary":"Envia um documento para a captura e extração de dados","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/uploadarquivoscapturadocumentos","deprecated":false},{"title":"/v1/captura/documentos/status","summary":"Consulta o status de documentos e das extrações (Captura)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/consultastatusdocumentoscaptura","deprecated":false},{"title":"/v1/captura/{id}","summary":"Consulta os dados extraídos da captura do documento enviado","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/consultadadosextraidoscaptura","deprecated":false},{"title":"/v1/captura/{id}","summary":"Aceita a prévia do evento financeiro da captura","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/aceitarpreviacaptura","deprecated":false},{"title":"/v1/captura/{id}","summary":"Recusa a captura (rejeita o evento financeiro sugerido)","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/v1/recusacaptura","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Captura":{"id":"components/schemas/Captura","kind":"json-schema","title":"Captura","data":{"description":"Dados extraídos do documento e a sugestão de evento financeiro","type":"object","properties":{"id":{"description":"ID da captura","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id_documento":{"description":"ID do documento que originou a captura","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"previa_evento_financeiro":{"description":"Prévia do evento financeiro extraído","allOf":[{"$ref":"#/components/schemas/PreviaEventoFinanceiro"}]},"status":{"description":"Status da captura","allOf":[{"$ref":"#/components/schemas/StatusCaptura"}],"example":"PROCESSANDO"},"sugestao_evento_financeiro":{"description":"Sugestão de evento financeiro gerada pela IA Captura","allOf":[{"$ref":"#/components/schemas/SugestaoEventoFinanceiro"}]}}}},"components/schemas/CapturaAceita":{"id":"components/schemas/CapturaAceita","kind":"json-schema","title":"CapturaAceita","data":{"description":"Captura após o aceite da prévia, com o evento financeiro criado","type":"object","properties":{"evento_financeiro":{"description":"Evento financeiro criado a partir do aceite","allOf":[{"$ref":"#/components/schemas/EventoFinanceiro"}]},"id":{"description":"ID da captura","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"status":{"description":"Status da captura","allOf":[{"$ref":"#/components/schemas/StatusCaptura"}],"example":"ACEITA"}}}},"components/schemas/CaptureStatusItem":{"id":"components/schemas/CaptureStatusItem","kind":"json-schema","title":"CaptureStatusItem","data":{"description":"Status de uma captura (extração) do documento","type":"object","properties":{"id_captura":{"description":"ID da captura","type":"string","example":"abcdef12-3456-7890-abcd-ef1234567890"},"status_captura":{"description":"Status da captura","allOf":[{"$ref":"#/components/schemas/StatusCaptura"}],"example":"ACEITA"}}}},"components/schemas/Categoria":{"id":"components/schemas/Categoria","kind":"json-schema","title":"Categoria","data":{"description":"Categoria do evento financeiro","type":"object","properties":{"id":{"description":"ID da categoria","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"nome":{"description":"Nome da categoria","type":"string","example":"Categoria 01"}}}},"components/schemas/CentroCusto":{"id":"components/schemas/CentroCusto","kind":"json-schema","title":"CentroCusto","data":{"description":"Centro de custo do evento financeiro","type":"object","properties":{"codigo":{"description":"Código do centro de custo","type":"string","example":"123"},"id":{"description":"ID do centro de custo","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"nome":{"description":"Nome do centro de custo","type":"string","example":"Centro de custo 01"}}}},"components/schemas/ComposicaoValor":{"id":"components/schemas/ComposicaoValor","kind":"json-schema","title":"ComposicaoValor","data":{"description":"Composição do valor da parcela","type":"object","properties":{"desconto":{"description":"Desconto","type":"number","example":10},"juros":{"description":"Juros","type":"number","example":2.5},"multa":{"description":"Multa","type":"number","example":5},"taxa":{"description":"Taxa","type":"number","example":3.75},"valor_bruto":{"description":"Valor bruto","type":"number","example":6.75}}}},"components/schemas/DocumentStatusItem":{"id":"components/schemas/DocumentStatusItem","kind":"json-schema","title":"DocumentStatusItem","data":{"description":"Status de um documento e das suas capturas","type":"object","properties":{"capturas":{"description":"Capturas geradas a partir do documento (vazio se não houver)","type":"array","items":{"$ref":"#/components/schemas/CaptureStatusItem"}},"id_documento":{"description":"ID do documento","type":"string","example":"1234abcd-5678-90ef-1234-567890abcdef"},"status_documento":{"description":"Status do processamento do documento","allOf":[{"$ref":"#/components/schemas/enums.DocumentStatus"}],"example":"RESOLVIDO"}}}},"components/schemas/DocumentStatusResume":{"id":"components/schemas/DocumentStatusResume","kind":"json-schema","title":"DocumentStatusResume","data":{"description":"Resultado da consulta de status, com os documentos e a paginação","type":"object","properties":{"itens":{"description":"Lista de documentos consultados","type":"array","items":{"$ref":"#/components/schemas/DocumentStatusItem"}},"paginacao":{"description":"Dados de paginação","allOf":[{"$ref":"#/components/schemas/Pagination"}]}}}},"components/schemas/ErroAPI":{"id":"components/schemas/ErroAPI","kind":"json-schema","title":"ErroAPI","data":{"description":"Modelo de resposta para erros da API","type":"object","properties":{"error":{"description":"Mensagem de erro","type":"string","example":"Mensagem de erro detalhada"}}}},"components/schemas/EventoFinanceiro":{"id":"components/schemas/EventoFinanceiro","kind":"json-schema","title":"EventoFinanceiro","data":{"description":"Evento financeiro criado a partir do aceite da prévia","type":"object","properties":{"data_competencia":{"description":"Data de competência","type":"string","example":"2026-06-30"},"descricao":{"description":"Descrição do evento financeiro","type":"string","example":"Recibo de energia"},"id":{"description":"ID do evento financeiro criado","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"tipo":{"description":"Tipo do evento financeiro","allOf":[{"$ref":"#/components/schemas/TipoEventoFinanceiro"}],"example":"DESPESA"},"valor":{"description":"Valor do evento financeiro","type":"number","example":1250.9}}}},"components/schemas/Fornecedor":{"id":"components/schemas/Fornecedor","kind":"json-schema","title":"Fornecedor","data":{"description":"Fornecedor associado ao evento financeiro","type":"object","properties":{"documento":{"description":"Documento do fornecedor","type":"string","example":"06462563000188"},"id":{"description":"ID do fornecedor","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"nome":{"description":"Nome do fornecedor","type":"string","example":"João Silva"}}}},"components/schemas/MetodoPagamento":{"id":"components/schemas/MetodoPagamento","kind":"json-schema","title":"MetodoPagamento","data":{"description":"Método de pagamento da parcela","type":"string","enum":["DEBITO_AUTOMATICO","BOLETO_BANCARIO","DEPOSITO_BANCARIO","TRANSFERENCIA_BANCARIA","DINHEIRO","CASHBACK","CHEQUE","CARTAO_CREDITO","CARTAO_DEBITO","CARTEIRA_DIGITAL","PROGRAMA_FIDELIDADE","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","PIX_PAGAMENTO_INSTANTANEO","VALE_REFEICAO","OUTRO","CARTAO_CREDITO_VIA_LINK","PIX_COBRANCA","CREDITO_LOJA","CREDITO_VIRTUAL","SEM_PAGAMENTO"],"x-enum-varnames":["PaymentMethodAutomaticDebit","PaymentMethodBankingBillet","PaymentMethodBankingDeposit","PaymentMethodBankingTransfer","PaymentMethodCash","PaymentMethodCashback","PaymentMethodCheck","PaymentMethodCreditCard","PaymentMethodDebitCard","PaymentMethodDigitalWallet","PaymentMethodFidelityProgram","PaymentMethodFoodVoucher","PaymentMethodFuelVoucher","PaymentMethodGiftVoucher","PaymentMethodInstantPayment","PaymentMethodMealVoucher","PaymentMethodOther","PaymentMethodPaymentLink","PaymentMethodPixCharge","PaymentMethodStoreCredit","PaymentMethodVirtualCredit","PaymentMethodWithoutPayment"]}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"description":"Dados de paginação da resposta","type":"object","properties":{"pagina_atual":{"description":"Página atual","type":"integer","example":1},"tamanho_pagina":{"description":"Tamanho da página","type":"integer","example":20},"total_itens":{"description":"Total de documentos encontrados","type":"integer","example":1},"total_paginas":{"description":"Total de páginas","type":"integer","example":1}}}},"components/schemas/Parcela":{"id":"components/schemas/Parcela","kind":"json-schema","title":"Parcela","data":{"description":"Parcela do evento financeiro","type":"object","properties":{"composicao_valor":{"description":"Composição do valor da parcela","allOf":[{"$ref":"#/components/schemas/ComposicaoValor"}]},"data_vencimento":{"description":"Data de vencimento da parcela","type":"string","example":"2024-10-28"},"metodo_pagamento":{"description":"Método de pagamento da parcela","allOf":[{"$ref":"#/components/schemas/MetodoPagamento"}],"example":"DINHEIRO"}}}},"components/schemas/PreviaEventoFinanceiro":{"id":"components/schemas/PreviaEventoFinanceiro","kind":"json-schema","title":"PreviaEventoFinanceiro","data":{"description":"Prévia do evento financeiro extraído do documento","type":"object","properties":{"categoria":{"description":"Categoria do evento financeiro","allOf":[{"$ref":"#/components/schemas/Categoria"}]},"centro_custo":{"description":"Centro de custo do evento financeiro","allOf":[{"$ref":"#/components/schemas/CentroCusto"}]},"data_competencia":{"description":"Data de competência","type":"string","example":"2024-10-28"},"descricao":{"description":"Descrição do evento financeiro","type":"string","example":"Recibo de despesa"},"fornecedor":{"description":"Fornecedor associado ao evento financeiro","allOf":[{"$ref":"#/components/schemas/Fornecedor"}]},"observacao":{"description":"Observação do evento financeiro","type":"string","example":"Parcelado em 10x"},"parcelas":{"description":"Parcelas do evento financeiro","type":"array","items":{"$ref":"#/components/schemas/Parcela"}},"referencia_externa":{"description":"Referência externa do evento financeiro","type":"string","example":"external-ref-123"},"tipo":{"description":"Tipo do evento financeiro","allOf":[{"$ref":"#/components/schemas/TipoEventoFinanceiro"}],"example":"DESPESA"},"valor":{"description":"Valor do evento financeiro","type":"number","example":6.75}}}},"components/schemas/ResumoEnvioDocumentoCaptura":{"id":"components/schemas/ResumoEnvioDocumentoCaptura","kind":"json-schema","title":"ResumoEnvioDocumentoCaptura","data":{"description":"Modelo de resposta do envio de documento para a captura","type":"object","properties":{"id":{"description":"ID do documento criado; chave para consultar o status","type":"string","example":"b9eac698-6eba-4901-b355-2f2748e386e0"},"nome":{"description":"Nome do arquivo enviado","type":"string","example":"recibo-01-06.pdf"}}}},"components/schemas/StatusCaptura":{"id":"components/schemas/StatusCaptura","kind":"json-schema","title":"StatusCaptura","data":{"description":"Status da captura","type":"string","enum":["PROCESSANDO","PENDENTE","ACEITA","REJEITADA","FALHA"],"x-enum-varnames":["StatusProcessing","StatusPending","StatusAccepted","StatusRejected","StatusFailed"]}},"components/schemas/SugestaoEventoFinanceiro":{"id":"components/schemas/SugestaoEventoFinanceiro","kind":"json-schema","title":"SugestaoEventoFinanceiro","data":{"description":"Sugestão de evento financeiro gerada pela IA Captura","type":"object","properties":{"id_parcela":{"description":"ID da parcela sugerida","type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"components/schemas/TipoEventoFinanceiro":{"id":"components/schemas/TipoEventoFinanceiro","kind":"json-schema","title":"TipoEventoFinanceiro","data":{"description":"Tipo do evento financeiro","type":"string","enum":["DESPESA","RECEITA"],"x-enum-varnames":["FinancialTypeExpense","FinancialTypeRevenue"]}},"components/schemas/enums.DocumentStatus":{"id":"components/schemas/enums.DocumentStatus","kind":"json-schema","title":"enums.DocumentStatus","data":{"type":"string","enum":["PENDENTE","PROCESSANDO","EXTRAINDO_DADOS","APLICANDO_REGRAS","AGUARDANDO_VINCULO_LANCAMENTO","CRIANDO_LANCAMENTOS_FINANCEIROS","PRONTO","IGNORADO","RESOLVIDO","ERRO","EXCLUIDO"],"x-enum-varnames":["DocumentStatusPending","DocumentStatusProcessing","DocumentStatusExtractingData","DocumentStatusApplyingRules","DocumentStatusWaitingFinancialLink","DocumentStatusCreatingFinancialEvents","DocumentStatusReady","DocumentStatusIgnored","DocumentStatusResolved","DocumentStatusError","DocumentStatusDeleted"]}},"components/schemas/http.Error":{"id":"components/schemas/http.Error","kind":"json-schema","title":"http.Error","data":{"type":"object","properties":{"error":{"type":"string"}}}},"schema_236":{"kind":"json-schema","data":{"type":"object","properties":{"arquivo":{"description":"Arquivo a ser enviado (PDF, JPEG, PNG ou BMP; máximo de 10 MB)","type":"string","format":"binary"},"descricao":{"description":"Descrição opcional do documento (máximo de 255 caracteres)","type":"string"}},"required":["arquivo"]},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"string"},"id":"schema_239"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/open-api-docs/developer-platform-open-api-capture","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/open-api-docs/developer-platform-open-api-capture.json?download"},{"url":"/_bundle/open-api-docs/developer-platform-open-api-capture.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Captura","description":"Operações relacionadas à captura de documentos"}},"baseSlug":"/open-api-docs/developer-platform-open-api-capture","routesMapping":{}}