{"openapi":"3.0.3","info":{"title":"Fiscal Pro — API de integração","version":"1.0.0","description":"Integração entre sistemas com OAuth Client Credentials. Empresa e aplicação são derivadas da credencial. Configure o ambiente fiscal no Fiscal Pro; a URL da API não seleciona homologação. Exemplos são fictícios."},"servers":[{"url":"https://api.fiscalpro.com.br"}],"paths":{"/integracao/oauth/token":{"post":{"operationId":"obter-token","tags":["Autenticação"],"summary":"Obter token de acesso","description":"Autentique sua aplicação com OAuth 2.0 Client Credentials. O token dura 3600 segundos (1 hora). Reutilize-o no backend até perto da expiração e renove usando as mesmas credenciais; este fluxo não usa refresh token.\n\nUse application/x-www-form-urlencoded. O servidor também aceita client_id e client_secret via HTTP Basic.\n\nCadastre e revogue credenciais no aplicativo. Este portal não solicita nem armazena seus segredos.","security":[],"parameters":[],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"},"example":{"access_token":"TOKEN_DE_EXEMPLO","token_type":"Bearer","expires_in":3600}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TokenInput"},"example":{"grant_type":"client_credentials","client_id":"SEU_CLIENT_ID","client_secret":"SEU_CLIENT_SECRET"}}}}}},"/integracao/v1/pessoas/{cpf_cnpj}":{"put":{"operationId":"sincronizar-pessoa","tags":["Cadastros"],"summary":"Sincronizar pessoa","description":"Crie ou atualize os dados cadastrais do cliente/tomador. O documento numérico válido vai no caminho. Inscrições e indicadores fiscais existentes são preservados.\n\n201 para cadastro novo; 200 para atualização. Novas pessoas são cadastradas como não contribuintes; revise os dados fiscais no Fiscal Pro quando necessário.\n\nNão envie inscrição estadual, municipal ou indicadores fiscais neste corpo.","security":[{"integrationOAuth":["pessoas:write"]}],"parameters":[{"name":"cpf_cnpj","in":"path","required":true,"schema":{"type":"string"},"description":"CPF/CNPJ numérico válido da pessoa."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pessoa"},"example":{"id_pessoa":1,"cpf_cnpj":"52998224725","criada":true}}}},"201":{"description":"Recurso/operação criado. Não implica autorização fiscal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pessoa"},"example":{"id_pessoa":1,"cpf_cnpj":"52998224725","criada":true}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PessoaInput"},"example":{"razao_social":"Cliente de exemplo","email":"cliente@example.com","endereco":{"cep":"01001000","logradouro":"Praça de exemplo","numero":"100","bairro":"Centro","codigo_municipio":3550308}}}}}}},"/integracao/v1/servicos":{"get":{"operationId":"listar-servicos","tags":["Cadastros"],"summary":"Listar serviços","description":"Consulte os serviços da empresa e use id_servico para preparar a NFS-e. Confira o indicador ativo e a configuração do serviço no Fiscal Pro.","security":[{"integrationOAuth":["servicos:read"]}],"parameters":[],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Servicos"},"example":[{"id_servico":1,"nome":"Serviço de exemplo","ativo":true}]}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/produtos":{"get":{"operationId":"listar-produtos","tags":["Cadastros"],"summary":"Listar produtos","description":"Consulte produtos cadastrados para NF-e e NFC-e. A API permite leitura do catálogo; a manutenção fiscal dos produtos acontece no Fiscal Pro.\n\nEnquanto houver proximo_id, use esse valor como apos_id na próxima chamada. IDs de produtos são específicos da empresa autenticada.","security":[{"integrationOAuth":["produtos:read"]}],"parameters":[{"name":"apos_id","schema":{"type":"integer","format":"int64","minimum":0,"default":0},"description":"Cursor inicial 0; depois use proximo_id.","in":"query"},{"name":"limite","schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"description":"De 1 a 100 produtos por página; padrão 50.","in":"query"}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Produtos"},"example":{"itens":[{"id_produto":1,"descricao":"Produto de exemplo","codigo":"PROD-001","unidade":"UN"}],"proximo_id":1}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfe":{"post":{"operationId":"criar-nfe","tags":["NF-e"],"summary":"Criar NF-e","description":"Envie os dados comerciais. A configuração da aplicação determina rascunho ou transmissão automática; empresa, ambiente, numeração e parâmetros fiscais vêm do Fiscal Pro.\n\nDe 1 a 250 itens e de 1 a 20 pagamentos. valor é unitário; desconto é o desconto total daquele item. Decimais são strings.\n\nOs valores são ilustrativos: pagamentos devem corresponder ao total efetivamente calculado, inclusive acréscimos tributários. Use IDs reais da sua empresa.\n\nInforme destinacao e presenca. Frete e entrega são opcionais; a entrega não altera o cadastro do cliente. Cartão exige dados reais quando aplicáveis.","security":[{"integrationOAuth":["nfe:write"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":200},"description":"Referência estável da venda. Não use outra chave para recuperar um timeout."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":55,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"201":{"description":"Recurso/operação criado. Não implica autorização fiscal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":55,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfeInput"},"example":{"cpf_cnpj":"52998224725","destinacao":"consumo_final","presenca":"internet","itens":[{"id_produto":1,"quantidade":"1","valor":"10.00"}],"pagamentos":[{"meio":"01","valor":"10.00","a_prazo":false}]}}}}}},"/integracao/v1/nfe/{id_operacao}":{"get":{"operationId":"consultar-nfe","tags":["NF-e"],"summary":"Consultar NF-e","description":"Consulte pelo id_operacao retornado na criação, usando a mesma aplicação. A consulta de uma pendência pode atualizar o resultado fiscal sem retransmitir o documento.\n\nRespeite proxima_consulta_em quando informado. Se requer_acao_manual for true, acompanhe a operação no Fiscal Pro; não crie outra venda.","security":[{"integrationOAuth":["nfe:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":55,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfe/{id_operacao}/xml":{"get":{"operationId":"baixar-nfe-xml","tags":["NF-e"],"summary":"Baixar XML da NF-e","description":"Receba o arquivo binário autenticado, vinculado à empresa e à aplicação. Disponível para operação autorizada ou cancelada, quando o arquivo existir. Confira os indicadores de disponibilidade na consulta.\n\n404 pode indicar operação inacessível ou arquivo ainda indisponível. Consulte a operação e tente o download mais tarde, sem repetir a emissão.","security":[{"integrationOAuth":["nfe:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Arquivo binário.","content":{"application/xml":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfe/{id_operacao}/pdf":{"get":{"operationId":"baixar-nfe-pdf","tags":["NF-e"],"summary":"Baixar PDF da NF-e","description":"Receba o arquivo binário autenticado, vinculado à empresa e à aplicação. Disponível para operação autorizada ou cancelada, quando o arquivo existir. Confira os indicadores de disponibilidade na consulta.\n\n404 pode indicar operação inacessível ou arquivo ainda indisponível. Consulte a operação e tente o download mais tarde, sem repetir a emissão.","security":[{"integrationOAuth":["nfe:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Arquivo binário.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfce":{"post":{"operationId":"criar-nfce","tags":["NFC-e"],"summary":"Criar NFC-e","description":"Envie os dados comerciais. A configuração da aplicação determina rascunho ou transmissão automática; empresa, ambiente, numeração e parâmetros fiscais vêm do Fiscal Pro.\n\nDe 1 a 250 itens e de 1 a 20 pagamentos. valor é unitário; desconto é o desconto total daquele item. Decimais são strings.\n\nOs valores são ilustrativos: pagamentos devem corresponder ao total efetivamente calculado, inclusive acréscimos tributários. Use IDs reais da sua empresa.\n\nVenda presencial para consumo final. Sem frete/entrega. CPF pode ser omitido quando a identificação for dispensável; para CNPJ, use NF-e. A autorização depende das validações do emissor.","security":[{"integrationOAuth":["nfce:write"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":200},"description":"Referência estável da venda. Não use outra chave para recuperar um timeout."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":65,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"201":{"description":"Recurso/operação criado. Não implica autorização fiscal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":65,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfceInput"},"example":{"itens":[{"id_produto":1,"quantidade":"1","valor":"10.00"}],"pagamentos":[{"meio":"01","valor":"10.00","a_prazo":false}]}}}}}},"/integracao/v1/nfce/{id_operacao}":{"get":{"operationId":"consultar-nfce","tags":["NFC-e"],"summary":"Consultar NFC-e","description":"Consulte pelo id_operacao retornado na criação, usando a mesma aplicação. A consulta de uma pendência pode atualizar o resultado fiscal sem retransmitir o documento.\n\nRespeite proxima_consulta_em quando informado. Se requer_acao_manual for true, acompanhe a operação no Fiscal Pro; não crie outra venda.","security":[{"integrationOAuth":["nfce:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoDocumento"},"example":{"id_operacao":"operacao_exemplo","modelo":65,"status":"rascunho","pendente_confirmacao":false,"tentativas_consulta":0,"requer_acao_manual":false,"xml_disponivel":false,"pdf_disponivel":false}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfce/{id_operacao}/xml":{"get":{"operationId":"baixar-nfce-xml","tags":["NFC-e"],"summary":"Baixar XML da NFC-e","description":"Receba o arquivo binário autenticado, vinculado à empresa e à aplicação. Disponível para operação autorizada ou cancelada, quando o arquivo existir. Confira os indicadores de disponibilidade na consulta.\n\n404 pode indicar operação inacessível ou arquivo ainda indisponível. Consulte a operação e tente o download mais tarde, sem repetir a emissão.","security":[{"integrationOAuth":["nfce:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Arquivo binário.","content":{"application/xml":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfce/{id_operacao}/pdf":{"get":{"operationId":"baixar-nfce-pdf","tags":["NFC-e"],"summary":"Baixar PDF da NFC-e","description":"Receba o arquivo binário autenticado, vinculado à empresa e à aplicação. Disponível para operação autorizada ou cancelada, quando o arquivo existir. Confira os indicadores de disponibilidade na consulta.\n\n404 pode indicar operação inacessível ou arquivo ainda indisponível. Consulte a operação e tente o download mais tarde, sem repetir a emissão.","security":[{"integrationOAuth":["nfce:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Arquivo binário.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfse":{"post":{"operationId":"criar-nfse","tags":["NFS-e"],"summary":"Criar NFS-e","description":"Envie os dados comerciais. A configuração da aplicação determina rascunho ou transmissão automática; empresa, ambiente, numeração e parâmetros fiscais vêm do Fiscal Pro.\n\nDe 1 a 50 itens. O tomador deve estar sincronizado e os serviços configurados. Não envie tributos, município, série ou ambiente no payload.\n\nO contrato comercial da integração não representa todos os campos da emissão manual. Confira a aplicabilidade dos cadastros antes de transmitir.","security":[{"integrationOAuth":["nfse:write"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":200},"description":"Referência estável da venda. Não use outra chave para recuperar um timeout."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoNfse"},"example":{"id_operacao":"operacao_exemplo","referencia_externa":"pedido-erp-0001","cpf_cnpj":"52998224725","status":"rascunho"}}}},"201":{"description":"Recurso/operação criado. Não implica autorização fiscal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoNfse"},"example":{"id_operacao":"operacao_exemplo","referencia_externa":"pedido-erp-0001","cpf_cnpj":"52998224725","status":"rascunho"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Erro"},{"$ref":"#/components/schemas/OperacaoNfse"}]}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseInput"},"example":{"cpf_cnpj":"52998224725","itens":[{"id_servico":1,"quantidade":"1","valor":"100.00"}]}}}}}},"/integracao/v1/nfse/{id_operacao}":{"get":{"operationId":"consultar-nfse","tags":["NFS-e"],"summary":"Consultar NFS-e","description":"Consulte pelo id_operacao retornado na criação, usando a mesma aplicação. A consulta de uma pendência pode atualizar o resultado fiscal sem retransmitir o documento.\n\nNFS-e possui resposta própria: numero é texto e id_nfse é o ID interno. Não presuma os campos xml_disponivel e pdf_disponivel de NF-e/NFC-e.","security":[{"integrationOAuth":["nfse:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Exemplo ilustrativo. Confira o status fiscal da operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperacaoNfse"},"example":{"id_operacao":"operacao_exemplo","referencia_externa":"pedido-erp-0001","cpf_cnpj":"52998224725","status":"rascunho"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/integracao/v1/nfse/{id_operacao}/pdf":{"get":{"operationId":"baixar-nfse-pdf","tags":["NFS-e"],"summary":"Baixar PDF da NFS-e","description":"Receba o arquivo binário autenticado, vinculado à empresa e à aplicação. O PDF exige NFS-e autorizada; arquivo ainda indisponível retorna 404.\n\n404 pode indicar operação inacessível ou arquivo ainda indisponível. Consulte a operação e tente o download mais tarde, sem repetir a emissão.\n\nA API de integração não oferece uma rota de XML de NFS-e nesta versão.","security":[{"integrationOAuth":["nfse:read"]}],"parameters":[{"name":"id_operacao","in":"path","required":true,"schema":{"type":"string"},"description":"ID da operação retornado pela mesma aplicação."}],"responses":{"200":{"description":"Arquivo binário.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido. Confira campos, formato e Idempotency-Key. Campos desconhecidos são recusados; o corpo JSON aceita até 64 KiB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Não autenticado. Confira as credenciais ou obtenha outro token se expirou. Não registre o segredo em logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"Acesso negado. Confira escopos, vínculo do responsável, permissões e bloqueios da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Não encontrado. Confira aplicação e ID da operação. O arquivo também pode estar indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito. A mesma chave foi reutilizada com outro conteúdo ou modelo. Recupere a venda original antes de decidir outra operação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Configuração pendente. Revise pessoa, serviço, produto ou configuração fiscal no Fiscal Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Falha interna. Preserve a referência e o ID retornado. Consulte a operação antes de repetir uma criação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"502":{"description":"Arquivo indisponível. O PDF de NFS-e não pôde ser entregue como arquivo válido. Consulte a operação e tente o download mais tarde.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"503":{"description":"Serviço indisponível. A autorização empresarial está indisponível. Aguarde antes de tentar novamente, preservando a chave da venda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}},"components":{"securitySchemes":{"integrationOAuth":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fiscalpro.com.br/integracao/oauth/token","scopes":{"pessoas:write":"Criar e atualizar dados cadastrais de pessoas.","servicos:read":"Consultar serviços cadastrados.","produtos:read":"Consultar o catálogo de produtos.","nfe:write":"Criar operações de NF-e.","nfe:read":"Consultar NF-e e baixar XML/PDF.","nfce:write":"Criar operações de NFC-e.","nfce:read":"Consultar NFC-e e baixar XML/PDF.","nfse:write":"Criar operações de NFS-e.","nfse:read":"Consultar NFS-e e baixar PDF."}}}}},"schemas":{"TokenInput":{"type":"object","additionalProperties":false,"properties":{"grant_type":{"type":"string","description":"Fluxo de autenticação entre sistemas.","enum":["client_credentials"]},"client_id":{"type":"string","description":"Identificador da credencial criada no Fiscal Pro."},"client_secret":{"type":"string","description":"Segredo exibido uma única vez. Mantenha no backend."}},"required":["grant_type","client_id","client_secret"]},"Token":{"type":"object","additionalProperties":false,"properties":{"access_token":{"type":"string","description":"Token de acesso."},"token_type":{"type":"string","description":"Bearer","enum":["Bearer"]},"expires_in":{"type":"integer","description":"Validade em segundos.","example":3600}},"required":[]},"PessoaInput":{"type":"object","additionalProperties":false,"properties":{"razao_social":{"type":"string","description":"Nome ou razão social, de 1 a 60 caracteres."},"nome_fantasia":{"type":"string","description":"Nome fantasia, opcional."},"email":{"type":"string","description":"E-mail válido, opcional."},"telefone":{"type":"string","description":"Telefone com 6 a 15 dígitos, opcional."},"endereco":{"type":"object","additionalProperties":false,"properties":{"cep":{"type":"string","description":"CEP com 8 dígitos."},"logradouro":{"type":"string","description":"Logradouro, até 60 caracteres."},"numero":{"type":"string","description":"Número, até 60 caracteres."},"complemento":{"type":"string","description":"Complemento, até 60 caracteres."},"bairro":{"type":"string","description":"Bairro, até 60 caracteres."},"codigo_municipio":{"type":"integer","description":"Código IBGE de 7 dígitos."}},"required":["cep","logradouro","bairro","codigo_municipio"]}},"required":["razao_social","endereco"]},"Pessoa":{"type":"object","additionalProperties":false,"properties":{"id_pessoa":{"type":"integer","format":"int64","minimum":1,"description":"ID cadastral."},"cpf_cnpj":{"type":"string","description":"Documento sincronizado."},"criada":{"type":"boolean"}},"required":[]},"Servicos":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id_servico":{"type":"integer","format":"int64","minimum":1,"description":"ID do serviço."},"nome":{"type":"string","description":"Nome do serviço."},"ativo":{"type":"boolean"}},"required":[]}},"Produtos":{"type":"object","additionalProperties":false,"properties":{"itens":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id_produto":{"type":"integer","format":"int64","minimum":1,"description":"ID do produto."},"descricao":{"type":"string","description":"Descrição."},"codigo":{"type":"string","description":"Código cadastral."},"unidade":{"type":"string","description":"Unidade comercial."}},"required":[]}},"proximo_id":{"type":"integer","format":"int64","minimum":1,"description":"Quando presente, use como apos_id da próxima página."}},"required":[]},"NfeInput":{"type":"object","additionalProperties":false,"properties":{"cpf_cnpj":{"type":"string","description":"Documento numérico válido de pessoa sincronizada. Na NFC-e, somente CPF; pode ser omitido quando a identificação for dispensável."},"destinacao":{"type":"string","description":"Finalidade comercial declarada.","enum":["consumo_final","revenda","industrializacao"]},"presenca":{"type":"string","description":"Modalidade da venda direta.","enum":["presencial","internet","teleatendimento","outros"]},"itens":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"object","additionalProperties":false,"properties":{"id_produto":{"type":"integer","format":"int64","minimum":1,"description":"ID obtido na listagem de produtos da empresa."},"quantidade":{"type":"string","description":"Quantidade positiva, até 4 casas decimais. Envie como texto decimal, com ponto."},"valor":{"type":"string","description":"Valor unitário positivo, até 10 casas decimais. Envie como texto decimal, com ponto."},"desconto":{"type":"string","description":"Desconto total do item, até 2 casas decimais; opcional. Envie como texto decimal, com ponto."}},"required":["id_produto","quantidade","valor"]},"description":"Produtos já cadastrados no Fiscal Pro."},"pagamentos":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","additionalProperties":false,"properties":{"meio":{"type":"string","description":"Código do meio de pagamento. Exemplos: 01 dinheiro, 03 crédito, 04 débito, 17 Pix, 99 outros."},"valor":{"type":"string","description":"Valor do pagamento, até 2 casas decimais. Envie como texto decimal, com ponto."},"descricao":{"type":"string","description":"Descrição obrigatória para meio 99."},"a_prazo":{"type":"boolean","description":"Indica pagamento a prazo."},"cartao":{"type":"object","additionalProperties":false,"properties":{"integrado":{"type":"boolean","description":"Indica integração com o pagamento."},"cnpj_instituicao":{"type":"string","description":"CNPJ real da instituição, quando aplicável."},"bandeira":{"type":"string","description":"Código da bandeira, quando aplicável."},"autorizacao":{"type":"string","description":"Autorização real, quando aplicável."},"cnpj_recebedor":{"type":"string","description":"CNPJ real do recebedor, quando aplicável."},"terminal":{"type":"string","description":"Identificação real do terminal, quando aplicável."}},"required":["integrado"]}},"required":["meio","valor"]},"description":"Devem corresponder ao total calculado, inclusive acréscimos aplicáveis. Sem troco neste contrato."},"frete":{"type":"object","additionalProperties":false,"properties":{"valor":{"type":"string","description":"Valor total do frete, até 2 casas decimais; rateado pelo backend. Envie como texto decimal, com ponto."},"responsabilidade":{"type":"string","description":"Responsabilidade do transporte.","enum":["emitente","destinatario","terceiros","proprio_emitente","proprio_destinatario"]}},"required":["valor","responsabilidade"]},"entrega":{"type":"object","additionalProperties":false,"properties":{"cpf_cnpj":{"type":"string","description":"Documento do local de entrega."},"nome":{"type":"string","description":"Nome do recebedor."},"endereco":{"type":"object","additionalProperties":false,"properties":{"cep":{"type":"string","description":"CEP com 8 dígitos."},"logradouro":{"type":"string","description":"Logradouro, até 60 caracteres."},"numero":{"type":"string","description":"Número, até 60 caracteres."},"complemento":{"type":"string","description":"Complemento, até 60 caracteres."},"bairro":{"type":"string","description":"Bairro, até 60 caracteres."},"codigo_municipio":{"type":"integer","description":"Código IBGE de 7 dígitos."}},"required":["cep","logradouro","bairro","codigo_municipio"]}},"required":["cpf_cnpj","nome","endereco"]}},"required":["cpf_cnpj","destinacao","presenca","itens","pagamentos"]},"NfceInput":{"type":"object","additionalProperties":false,"properties":{"cpf_cnpj":{"type":"string","description":"Documento numérico válido de pessoa sincronizada. Na NFC-e, somente CPF; pode ser omitido quando a identificação for dispensável."},"destinacao":{"type":"string","description":"Esta versão aceita consumo final; padrão quando omitido.","enum":["consumo_final"]},"presenca":{"type":"string","description":"Esta versão aceita venda presencial; padrão quando omitido.","enum":["presencial"]},"itens":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"object","additionalProperties":false,"properties":{"id_produto":{"type":"integer","format":"int64","minimum":1,"description":"ID obtido na listagem de produtos da empresa."},"quantidade":{"type":"string","description":"Quantidade positiva, até 4 casas decimais. Envie como texto decimal, com ponto."},"valor":{"type":"string","description":"Valor unitário positivo, até 10 casas decimais. Envie como texto decimal, com ponto."},"desconto":{"type":"string","description":"Desconto total do item, até 2 casas decimais; opcional. Envie como texto decimal, com ponto."}},"required":["id_produto","quantidade","valor"]},"description":"Produtos já cadastrados no Fiscal Pro."},"pagamentos":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","additionalProperties":false,"properties":{"meio":{"type":"string","description":"Código do meio de pagamento. Exemplos: 01 dinheiro, 03 crédito, 04 débito, 17 Pix, 99 outros."},"valor":{"type":"string","description":"Valor do pagamento, até 2 casas decimais. Envie como texto decimal, com ponto."},"descricao":{"type":"string","description":"Descrição obrigatória para meio 99."},"a_prazo":{"type":"boolean","description":"Indica pagamento a prazo."},"cartao":{"type":"object","additionalProperties":false,"properties":{"integrado":{"type":"boolean","description":"Indica integração com o pagamento."},"cnpj_instituicao":{"type":"string","description":"CNPJ real da instituição, quando aplicável."},"bandeira":{"type":"string","description":"Código da bandeira, quando aplicável."},"autorizacao":{"type":"string","description":"Autorização real, quando aplicável."},"cnpj_recebedor":{"type":"string","description":"CNPJ real do recebedor, quando aplicável."},"terminal":{"type":"string","description":"Identificação real do terminal, quando aplicável."}},"required":["integrado"]}},"required":["meio","valor"]},"description":"Devem corresponder ao total calculado, inclusive acréscimos aplicáveis. Sem troco neste contrato."}},"required":["itens","pagamentos"]},"NfseInput":{"type":"object","additionalProperties":false,"properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ válido de pessoa sincronizada."},"itens":{"type":"array","minItems":1,"maxItems":50,"description":"Serviços cadastrados e configurados na empresa.","items":{"type":"object","additionalProperties":false,"properties":{"id_servico":{"type":"integer","format":"int64","minimum":1,"description":"ID obtido na listagem de serviços."},"quantidade":{"type":"string","description":"Quantidade positiva, até 6 casas decimais. Envie como texto decimal, com ponto."},"valor":{"type":"string","description":"Valor unitário positivo, até 2 casas decimais. Envie como texto decimal, com ponto."}},"required":["id_servico","quantidade","valor"]}}},"required":["cpf_cnpj","itens"]},"OperacaoDocumento":{"type":"object","additionalProperties":false,"properties":{"id_operacao":{"type":"string","description":"Identificador opaco para consultas pela mesma aplicação."},"id_nfe":{"type":"integer","format":"int64","minimum":1,"description":"ID interno, diferente do número fiscal."},"modelo":{"type":"integer","enum":[55,65]},"status":{"type":"string","description":"Estado da operação. HTTP 200/201 não equivale a autorização fiscal.","enum":["processando","rascunho","pendente","autorizada","rejeitada","cancelada","erro"]},"numero":{"type":"integer"},"serie":{"type":"integer"},"chave":{"type":"string","description":"Chave de acesso quando disponível."},"protocolo":{"type":"string","description":"Protocolo quando disponível."},"status_cod":{"type":"integer"},"status_motivo":{"type":"string","description":"Motivo retornado pela emissão."},"pendente_confirmacao":{"type":"boolean"},"proxima_consulta_em":{"type":"string","format":"date-time","nullable":true},"tentativas_consulta":{"type":"integer"},"requer_acao_manual":{"type":"boolean"},"xml_disponivel":{"type":"boolean"},"pdf_disponivel":{"type":"boolean"},"erro":{"type":"string","description":"Mensagem quando houver falha."},"criada_em":{"type":"string","format":"date-time"},"atualizada_em":{"type":"string","format":"date-time"}},"required":[]},"OperacaoNfse":{"type":"object","additionalProperties":false,"properties":{"id_operacao":{"type":"string","description":"Identificador opaco para consultas pela mesma aplicação."},"id_nfse":{"type":"integer","format":"int64","minimum":1,"description":"ID interno da NFS-e."},"referencia_externa":{"type":"string","description":"Referência de idempotência."},"cpf_cnpj":{"type":"string","description":"Documento do tomador."},"status":{"type":"string","description":"Estado da operação. HTTP 200/201 não equivale a autorização fiscal.","enum":["processando","rascunho","pendente","autorizada","rejeitada","cancelada","erro"]},"provider_status":{"type":"string","description":"Estado retornado pelo provedor, quando disponível."},"numero":{"type":"string","description":"Número fiscal quando disponível."},"codigo_verificacao":{"type":"string","description":"Código de verificação quando disponível."},"link_url":{"type":"string","description":"Referência retornada pelo provedor, quando houver. Prefira o download autenticado de PDF."},"erro":{"type":"string","description":"Mensagem quando houver falha."},"criada_em":{"type":"string","format":"date-time"},"atualizada_em":{"type":"string","format":"date-time"}},"required":[]},"Erro":{"type":"object","properties":{"erro":{"type":"string","description":"Mensagem de erro."},"codigo":{"type":"string","description":"Código contextual, quando informado."}}}}}}