{"items":[{"type":"link","label":"Notas fiscais","link":"/open-api-docs/open-api-invoice","routeSlug":"/open-api-docs/open-api-invoice","content":{"contentType":"overview","meta":{"name":"Notas fiscais"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"open-api-invoice.json","url":"/_bundle/open-api-docs/open-api-invoice.json?download"},{"kind":"download","label":"open-api-invoice.yaml","url":"/_bundle/open-api-docs/open-api-invoice.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/open-api-invoice","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Notas fiscais (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 Notas Fiscais (v1) tem como objetivo permitir a consulta de documentos fiscais de forma programática. No momento, o suporte disponível é apenas para consulta de notas de produto NF-e emitidas no ERP, permitindo que sistemas externos recuperem informações fiscais, validem dados e integrem essas notas aos seus próprios fluxos."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Essa API possibilita acessar detalhes das notas já emitidas, acompanhar informações essenciais para controle fiscal e garantir maior eficiência na integração entre sistemas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/articles/4424707438605-Como-acessar-notas-fiscais-emitidas-na-Conta-Azul"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/articles/4424707438605-Como-acessar-notas-fiscais-emitidas-na-Conta-Azul"},"children":[]}]}]}]}]}],"sectionId":"/open-api-docs/open-api-invoice"}],"sectionId":"/open-api-docs/open-api-invoice"}]}]}},{"type":"group","label":"v1","link":"/open-api-docs/open-api-invoice/v1","routeSlug":"/open-api-docs/open-api-invoice/v1","items":[{"label":"Retornar as notas fiscais por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisporfiltro","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisporfiltro","metadata":{"seo":{"title":"Retornar as notas fiscais por filtro","description":"Permite consultar todas as notas fiscais de produto (NFe) já emitidas no ERP, com suporte a filtros como data, número da nota, id da venda.. Este endpoint retorna somente NFe com status EMITIDA e CORRIGIDA COM SUCESSO (outros status em construção). Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterNotasFiscaisPorFiltro","name":"Retornar as notas fiscais por filtro","isWebhook":false,"pointer":"/paths/~1v1~1notas-fiscais/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as notas fiscais por filtro","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":"Permite consultar todas as notas fiscais de produto (NFe) já emitidas no ERP, com suporte a filtros como data, número da nota, id da venda.. Este endpoint retorna somente NFe com status EMITIDA e CORRIGIDA COM SUCESSO (outros status em construção). Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."},"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":"data_inicial","in":"query","schemaId":"schema_271","description":"Data inicial no formato YYYY-MM-DD","required":true},{"name":"data_final","in":"query","schemaId":"schema_271","description":"Data final no formato YYYY-MM-DD","required":true},{"name":"pagina","in":"query","schemaId":"schema_272","description":"Página"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_273","description":"Tamanho da página"},{"name":"documento_tomador","in":"query","schemaId":"schema_271","description":"Documento do tomador","example":"12345678900"},{"name":"numero_nota","in":"query","schemaId":"schema_271","description":"Número da nota fiscal","example":"1234"},{"name":"id_venda","in":"query","schemaId":"schema_271","description":"ID da venda","example":"550e8400-e29b-41d4-a716-446655440000"}],"pointer":"/paths/~1v1~1notas-fiscais/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/notas-fiscais","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"data_inicial","in":"query","required":true,"schemaId":"schema_271"},{"name":"data_final","in":"query","required":true,"schemaId":"schema_271"},{"name":"pagina","in":"query","schemaId":"schema_272"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_273"},{"name":"documento_tomador","in":"query","example":"12345678900","schemaId":"schema_271"},{"name":"numero_nota","in":"query","example":"1234","schemaId":"schema_271"},{"name":"id_venda","in":"query","example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_271"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/notas-fiscais","href":"v1/obternotasfiscaisporfiltro","openApiOperationId":"obterNotasFiscaisPorFiltro","summary":"Retornar as notas fiscais por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","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/NotaFiscalPorFiltro"}},"schemaId":"components/schemas/NotaFiscalPorFiltro"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1notas-fiscais/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotaFiscalPorFiltro","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotaFiscalPorFiltro"}}},{"code":"400","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/obternotasfiscaisporfiltro"}],"panels":[]}]},"httpPath":"/v1/notas-fiscais"},{"label":"Retornar notas fiscais de serviço por filtros","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisservicoporfiltro","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisservicoporfiltro","metadata":{"seo":{"title":"Retornar notas fiscais de serviço por filtros","description":"Permite consultar todas as notas fiscais de serviço (NFS-e) já emitidas no ERP, com uso de filtros como data, número da nota, id da venda.. Este endpoint retorna NFS-e com todos os status possíveis a partir da emissão. Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterNotasFiscaisServicoPorFiltro","name":"Retornar notas fiscais de serviço por filtros","isWebhook":false,"pointer":"/paths/~1v1~1notas-fiscais-servico/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar notas fiscais de serviço por filtros","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":"Permite consultar todas as notas fiscais de serviço (NFS-e) já emitidas no ERP, com uso de filtros como data, número da nota, id da venda.. Este endpoint retorna NFS-e com todos os status possíveis a partir da emissão. Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."},"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":"pagina","in":"query","schemaId":"schema_274","description":"Número da página"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_273","description":"Tamanho da página (valores válidos: 10, 20, 50, 100)"},{"name":"data_competencia_de","in":"query","schemaId":"schema_271","description":"Data de emissão inicial no formato YYYY-MM-DD (range máximo: 15 dias)","required":true,"example":"2024-01-01"},{"name":"data_competencia_ate","in":"query","schemaId":"schema_271","description":"Data de emissão final no formato YYYY-MM-DD (range máximo: 15 dias)","required":true,"example":"2024-01-15"},{"name":"ids","in":"query","schemaId":"schema_275","description":"Lista de UUIDs das notas fiscais de serviço"},{"name":"id_cliente","in":"query","schemaId":"schema_275","description":"Lista de IDs de clientes (UUIDs)"},{"name":"numero_venda","in":"query","schemaId":"schema_276","description":"Número da venda","example":1001},{"name":"numero_nfse_inicial","in":"query","schemaId":"schema_276","description":"Número inicial da NFS-e","example":100},{"name":"numero_nfse_final","in":"query","schemaId":"schema_276","description":"Número final da NFS-e","example":200},{"name":"numero_rps_inicial","in":"query","schemaId":"schema_276","description":"Número inicial do RPS","example":1000},{"name":"numero_rps_final","in":"query","schemaId":"schema_276","description":"Número final do RPS","example":2000},{"name":"status","in":"query","schemaId":"schema_277","description":"Status da nota fiscal"},{"name":"tipo_negociacao","in":"query","schemaId":"schema_278","description":"Tipo de negociação"}],"pointer":"/paths/~1v1~1notas-fiscais-servico/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/notas-fiscais-servico","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_274"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_273"},{"name":"data_competencia_de","in":"query","required":true,"example":"2024-01-01","schemaId":"schema_271"},{"name":"data_competencia_ate","in":"query","required":true,"example":"2024-01-15","schemaId":"schema_271"},{"name":"ids","in":"query","schemaId":"schema_275","style":"form","explode":false},{"name":"id_cliente","in":"query","schemaId":"schema_275","style":"form","explode":false},{"name":"numero_venda","in":"query","example":1001,"schemaId":"schema_276"},{"name":"numero_nfse_inicial","in":"query","example":100,"schemaId":"schema_276"},{"name":"numero_nfse_final","in":"query","example":200,"schemaId":"schema_276"},{"name":"numero_rps_inicial","in":"query","example":1000,"schemaId":"schema_276"},{"name":"numero_rps_final","in":"query","example":2000,"schemaId":"schema_276"},{"name":"status","in":"query","schemaId":"schema_277","style":"form","explode":false},{"name":"tipo_negociacao","in":"query","schemaId":"schema_278"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/notas-fiscais-servico","href":"v1/obternotasfiscaisservicoporfiltro","openApiOperationId":"obterNotasFiscaisServicoPorFiltro","summary":"Retornar notas fiscais de serviço por filtros"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","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/NotaFiscalServicoPorFiltro"}},"schemaId":"components/schemas/NotaFiscalServicoPorFiltro"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1notas-fiscais-servico/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotaFiscalServicoPorFiltro","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotaFiscalServicoPorFiltro"}}},{"code":"400","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/obternotasfiscaisservicoporfiltro"}],"panels":[]}]},"httpPath":"/v1/notas-fiscais-servico"},{"label":"Vincular nota fiscal a mdfe","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/vincularnotafiscalmdfe","routeSlug":"/open-api-docs/open-api-invoice/v1/vincularnotafiscalmdfe","metadata":{"seo":{"title":"Vincular nota fiscal a mdfe","description":"Permite associar uma ou mais notas fiscais (identificadas pelas chaves de acesso) a um MDF-e (Manifesto Eletrônico de Documento Fiscal). É possível também informar o status do vínculo (ex: \"AUTORIZADO\", \"ENCERRADO\", \"CANCELADO\"). Apoio no controle logístico e fiscal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"vincularNotaFiscalMdfe","name":"Vincular nota fiscal a mdfe","isWebhook":false,"pointer":"/paths/~1v1~1notas-fiscais~1vinculo-mdfe/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Vincular nota fiscal a mdfe","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":"Permite associar uma ou mais notas fiscais (identificadas pelas chaves de acesso) a um MDF-e (Manifesto Eletrônico de Documento Fiscal). É possível também informar o status do vínculo (ex: \"AUTORIZADO\", \"ENCERRADO\", \"CANCELADO\"). Apoio no controle logístico e fiscal."},"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":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkNotaFiscalMdfe"}},"schemaId":"components/schemas/LinkNotaFiscalMdfe","pointer":"/paths/~1v1~1notas-fiscais~1vinculo-mdfe/post/requestBody","description":"Dados para vincular nota fiscal a mdfe"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/notas-fiscais/vinculo-mdfe","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkNotaFiscalMdfe"}},"responseCodes":["204","400","404","500"],"pointer":"/v1/notas-fiscais/vinculo-mdfe","href":"v1/vincularnotafiscalmdfe","openApiOperationId":"vincularNotaFiscalMdfe","summary":"Vincular nota fiscal a mdfe"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/LinkNotaFiscalMdfe","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkNotaFiscalMdfe"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1notas-fiscais~1vinculo-mdfe/post/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":"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/vincularnotafiscalmdfe"}],"panels":[]}]},"httpPath":"/v1/notas-fiscais/vinculo-mdfe"},{"label":"Retornar a nota fiscal por chave","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotafiscalporchave","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotafiscalporchave","metadata":{"seo":{"title":"Retornar a nota fiscal por chave","description":"Permite consultar dados de uma nota fiscal específica, buscando pela sua chave de acesso."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterNotaFiscalPorChave","name":"Retornar a nota fiscal por chave","isWebhook":false,"pointer":"/paths/~1v1~1notas-fiscais~1{chave}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a nota fiscal por chave","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":"Permite consultar dados de uma nota fiscal específica, buscando pela sua chave de acesso."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A resposta é um conteúdo binário e deve ser tratada como download de arquivo:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quando a nota "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"não"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" possui carta de correção, o corpo é o XML da NF-e."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quando a nota possui carta de correção (CC-e), o corpo é um arquivo "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contendo o XML da NF-e e o(s) XML(s) da(s) carta(s) de correção."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Por ser binário, ao abrir a resposta como texto os dados aparecem como caracteres ilegíveis. Salve o corpo da resposta em um arquivo e, quando for um ZIP, descompacte-o para acessar os XMLs."},"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":"chave","in":"path","schemaId":"schema_271","description":"Chave da nota fiscal","required":true}],"pointer":"/paths/~1v1~1notas-fiscais~1{chave}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/notas-fiscais/{chave}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"chave","in":"path","required":true,"schemaId":"schema_271"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/notas-fiscais/{chave}","href":"v1/obternotafiscalporchave","openApiOperationId":"obterNotaFiscalPorChave","summary":"Retornar a nota fiscal por chave"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-invoice","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":"XML da NF-e ou, quando houver carta de correção, um arquivo ZIP com o XML da NF-e e o(s) XML(s) da(s) carta(s) de correção"},"children":[]}]}]}],"mediaType":"application/xml","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"schema_279"},"application/zip":{"schemaId":"schema_279"}},"schemaId":"schema_279"},{"code":"400","description":"Bad Request","mediaType":"application/xml","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/xml","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/xml","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1notas-fiscais~1{chave}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"schema_279"},"application/zip":{"schemaId":"schema_279"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/xml","application/zip"],"mediaTypeContent":{"application/xml":{"schemaId":"components/schemas/ErroAPI"},"application/zip":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/obternotafiscalporchave"}],"panels":[]}]},"httpPath":"/v1/notas-fiscais/{chave}"}],"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":"Operações relacionadas a notas fiscais"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/notas-fiscais","summary":"Retornar as notas fiscais por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/obternotasfiscaisporfiltro","deprecated":false},{"title":"/v1/notas-fiscais-servico","summary":"Retornar notas fiscais de serviço por filtros","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/obternotasfiscaisservicoporfiltro","deprecated":false},{"title":"/v1/notas-fiscais/vinculo-mdfe","summary":"Vincular nota fiscal a mdfe","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/vincularnotafiscalmdfe","deprecated":false},{"title":"/v1/notas-fiscais/{chave}","summary":"Retornar a nota fiscal por chave","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/obternotafiscalporchave","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CidadeEmissaoNotaFiscalServico":{"id":"components/schemas/CidadeEmissaoNotaFiscalServico","kind":"json-schema","title":"CidadeEmissaoNotaFiscalServico","data":{"description":"Cidade de emissão da nota fiscal de serviço","type":"object","properties":{"estado":{"description":"Estado (UF)","type":"string","example":"SC"},"nome":{"description":"Nome da cidade","type":"string","example":"Joinville"}}}},"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/InformacaoTransmissaoNotaFiscalServico":{"id":"components/schemas/InformacaoTransmissaoNotaFiscalServico","kind":"json-schema","title":"InformacaoTransmissaoNotaFiscalServico","data":{"description":"Informações de transmissão da nota fiscal de serviço","type":"object","properties":{"data_inicio_cancelamento":{"description":"Data de início do cancelamento","type":"string","example":"2024-01-16T14:20:00"},"data_inicio_emissao":{"description":"Data de início da emissão","type":"string","example":"2024-01-15T10:30:00"}}}},"components/schemas/InformacoesCancelamentoNotaFiscalServico":{"id":"components/schemas/InformacoesCancelamentoNotaFiscalServico","kind":"json-schema","title":"InformacoesCancelamentoNotaFiscalServico","data":{"description":"Informações de cancelamento da nota fiscal de serviço","type":"object","properties":{"motivo":{"description":"Motivo do cancelamento","type":"string","example":"Erro na alíquota de ISS informada"},"usuario":{"description":"Usuário que cancelou","type":"string","example":"Empresa Teste"}}}},"components/schemas/LinkNotaFiscalMdfe":{"id":"components/schemas/LinkNotaFiscalMdfe","kind":"json-schema","title":"LinkNotaFiscalMdfe","data":{"description":"Modelo de link de chaves de notas fiscais para MDF-e","type":"object","required":["chaves_acesso","identificador"],"properties":{"chaves_acesso":{"description":"Chaves de acesso das notas fiscais vinculadas ao MDF-e","type":"array","items":{"type":"string"},"example":["42250323643586000108550010000001151606401726","42250323643586000108550010000001141054498495"]},"identificador":{"description":"Identificador do MDF-e","type":"string","example":"345345"},"status":{"description":"Status do MDF-e","allOf":[{"$ref":"#/components/schemas/StatusDoMDFE"}],"example":"ENCERRADO"}}}},"components/schemas/NotaFiscal":{"id":"components/schemas/NotaFiscal","kind":"json-schema","title":"NotaFiscal","data":{"description":"Modelo de resposta para as notas fiscais contendo todas as informações necessárias","type":"object","properties":{"chave_acesso":{"description":"Chave de acesso da nota fiscal","type":"string","example":"42250323643586000108550010000001151606401726"},"data_emissao":{"description":"Data de emissão da nota fiscal","type":"string","example":"2025-01-15T10:30:00Z"},"nome_destinatario":{"description":"Nome do destinatário","type":"string","example":"EMPRESA EXEMPLO LTDA"},"numero_nota":{"description":"Número da nota fiscal","type":"integer","example":123456},"status":{"description":"Status da nota fiscal","allOf":[{"$ref":"#/components/schemas/StatusDaNotaFiscal"}],"example":"EMITIDA"}}}},"components/schemas/NotaFiscalPorFiltro":{"id":"components/schemas/NotaFiscalPorFiltro","kind":"json-schema","title":"NotaFiscalPorFiltro","data":{"description":"Modelo de resposta para as notas fiscais contendo todas as informações necessárias","type":"object","properties":{"itens":{"description":"Lista de notas fiscais","type":"array","items":{"$ref":"#/components/schemas/NotaFiscal"}},"paginacao":{"description":"Paginação","allOf":[{"$ref":"#/components/schemas/Pagina_o"}]}}}},"components/schemas/NotaFiscalServico":{"id":"components/schemas/NotaFiscalServico","kind":"json-schema","title":"NotaFiscalServico","data":{"description":"Nota fiscal de serviço","type":"object","properties":{"cidade_emissao":{"description":"Cidade de emissão","allOf":[{"$ref":"#/components/schemas/CidadeEmissaoNotaFiscalServico"}]},"codigo_cnae":{"description":"Código CNAE","type":"string","example":"6201-5/00"},"data_competencia":{"description":"Data de competência","type":"string","example":"2024-01-15"},"documento_cliente":{"description":"Documento do cliente","type":"string","example":"12345678000190"},"escriturado_manualmente":{"description":"Indica se foi escriturado manualmente","type":"boolean","example":false},"id":{"description":"UUID da nota fiscal de serviço","type":"string","example":"550e8400-e29b-41d4-a716-446655440099"},"id_contrato":{"description":"UUID do contrato","type":"string","example":"550e8400-e29b-41d4-a716-446655440001"},"id_venda":{"description":"UUID da venda","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"informacao_transmissao":{"description":"Informações de transmissão","allOf":[{"$ref":"#/components/schemas/InformacaoTransmissaoNotaFiscalServico"}]},"informacoes_cancelamento":{"description":"Informações de cancelamento","allOf":[{"$ref":"#/components/schemas/InformacoesCancelamentoNotaFiscalServico"}]},"nome_cliente":{"description":"Nome do cliente","type":"string","example":"EMPRESA EXEMPLO LTDA"},"numero_nfse":{"description":"Número da NFS-e","type":"integer","example":123},"numero_rps":{"description":"Número do RPS","type":"integer","example":67890},"numero_venda":{"description":"Número da venda","type":"string","example":"1001"},"status":{"description":"Status da nota fiscal","allOf":[{"$ref":"#/components/schemas/StatusNotaFiscalServico"}],"example":"EMITIDA"},"valor_total_nfse":{"description":"Valor total da NFS-e","type":"number","example":1500.5}}}},"components/schemas/NotaFiscalServicoPorFiltro":{"id":"components/schemas/NotaFiscalServicoPorFiltro","kind":"json-schema","title":"NotaFiscalServicoPorFiltro","data":{"description":"Modelo de resposta paginada para notas fiscais de serviço","type":"object","properties":{"itens":{"type":"array","items":{"$ref":"#/components/schemas/NotaFiscalServico"}},"paginacao":{"$ref":"#/components/schemas/Pagina_o"}}}},"components/schemas/StatusDaNotaFiscal":{"id":"components/schemas/StatusDaNotaFiscal","kind":"json-schema","title":"StatusDaNotaFiscal","data":{"description":"Enum de status da nota fiscal","type":"string","enum":["EMITIDA","CORRIGIDA_SUCESSO"],"x-enum-varnames":["EMITTED","SUCCESS_CORRECTION"]}},"components/schemas/StatusDoMDFE":{"id":"components/schemas/StatusDoMDFE","kind":"json-schema","title":"StatusDoMDFE","data":{"description":"Enum de status do MDF-e (Manifesto Eletrônico de Documentos Fiscais)","type":"string","enum":["AUTORIZADO","ENCERRADO","CANCELADO"],"x-enum-varnames":["AUTHORIZED","CLOSED","CANCELED"]}},"components/schemas/StatusNotaFiscalServico":{"id":"components/schemas/StatusNotaFiscalServico","kind":"json-schema","title":"StatusNotaFiscalServico","data":{"description":"Enum de status da nota fiscal de serviço","type":"string","enum":["PENDENTE","PRONTA_ENVIO","AGUARDANDO_RETORNO","EM_ESPERA","EMITINDO","EMITIDA","CANCELADA","FALHA","FALHA_CANCELAMENTO","CORRIGIDA_SUCESSO","AGUARDANDO_CORRECAO","FALHA_CORRECAO","DENEGADA","CANCELAMENTO_MANUAL"],"x-enum-varnames":["SERVICE_INVOICE_PENDING","SERVICE_INVOICE_READY_TO_SEND","SERVICE_INVOICE_WAITING_RETURN","SERVICE_INVOICE_ON_HOLD","SERVICE_INVOICE_EMITTING","SERVICE_INVOICE_EMITTED","SERVICE_INVOICE_CANCELED","SERVICE_INVOICE_FAILURE","SERVICE_INVOICE_CANCELLATION_FAILURE","SERVICE_INVOICE_SUCCESS_CORRECTION","SERVICE_INVOICE_WAITING_CORRECTION","SERVICE_INVOICE_CORRECTION_FAILURE","SERVICE_INVOICE_DENIED","SERVICE_INVOICE_MANUAL_CANCELLATION"]}},"components/schemas/Pagina_o":{"id":"components/schemas/Pagina_o","kind":"json-schema","title":"Pagina_o","data":{"description":"Modelo de resposta para paginação dos resultados","type":"object","properties":{"pagina_atual":{"description":"Página atual","type":"integer","example":1},"tamanho_pagina":{"description":"Tamanho da página","type":"integer","example":10},"total_itens":{"description":"Total de itens","type":"integer","example":50},"total_paginas":{"description":"Total de páginas","type":"integer","example":5}}}},"schema_271":{"kind":"json-schema","data":{"type":"string"},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"integer","enum":[10,20,50,100],"default":10},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"array","items":{"enum":["PENDENTE","PRONTA_ENVIO","AGUARDANDO_RETORNO","EM_ESPERA","EMITINDO","EMITIDA","CANCELADA","FALHA","FALHA_CANCELAMENTO","CORRIGIDA_SUCESSO","AGUARDANDO_CORRECAO","FALHA_CORRECAO","DENEGADA","CANCELAMENTO_MANUAL"],"type":"string"}},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"string","enum":["VENDA","CONTRATO"]},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_279"}},"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/open-api-invoice","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/open-api-docs/open-api-invoice","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/open-api-docs/open-api-invoice.json?download"},{"url":"/_bundle/open-api-docs/open-api-invoice.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Notas fiscais","description":"A API de Notas Fiscais (v1) tem como objetivo permitir a consulta de documentos fiscais de forma programática. No momento, o suporte disponível é apenas para consulta de notas de produto NF-e emitidas no ERP, permitindo que sistemas externos recuperem informações fiscais, validem dados e integrem essas notas aos seus próprios fluxos.\n\nEssa API possibilita acessar detalhes das notas já emitidas, acompanhar informações essenciais para controle fiscal e garantir maior eficiência na integração entre sistemas.\n\nSe desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:\n\n[https://ajuda.contaazul.com/hc/pt-br/articles/4424707438605-Como-acessar-notas-fiscais-emitidas-na-Conta-Azul](https://ajuda.contaazul.com/hc/pt-br/articles/4424707438605-Como-acessar-notas-fiscais-emitidas-na-Conta-Azul) "}},"baseSlug":"/open-api-docs/open-api-invoice","routesMapping":{}}