openapi: 3.0.1 info: title: Nota Fiscal de Produto description: "# Introducão\nSeja bem-vindo a documentação da API de Nota Fiscal de Produto!\nNossa API foi criada utilizando o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada abaixo.\n\n\n# Como usar a API?\nLogo a seguir você encontrará todos os recursos e metódos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\n\n\n# Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra no topo desta página para que os métodos funcionem corretamente.\nNo seu código de integração temos suporte para autenticação de diversas formas sendo eles: \nHTTP Header (Authorization) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).\n\n" version: v2 servers: - url: https://api.nfse.io/ tags: - name: Companies description: | Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - name: Companies Certificates description: | Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo **e-CNPJ A1** ou **NFE A1** em uma **Empresa** e vincula-lo para processamentos. O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. - name: Companies State Taxes description: | Está sessão é destinada às **Incrições Estaduais(IE).** Uma **Incrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. Utilizando as informações abaixo você pode criar novas IEs na empresa para processar **Documentos Fiscais.** Além disso, também é possível listar as IEs por empresa e consultar, alterar e exluir uma IE pelo ID da mesma. - name: Product Invoices description: "Nesta sessão estão disponíveis informações necessárias para emitir uma Nota Fiscal Eletrônica usando a nossa API. \n\nVocê também encontrará informações sobre consulta de uma nota fiscal por ID, consulta de uma lista de notas por empresa, consulta do PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) e consulta do XML da nota fiscal eletrônica.\n" - name: WebHooks description: | Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados criando notificações para os webhooks ativos e configurados para receber os eventos. Um **Webhook** é semelhante a uma assinatura em um sistema de publicação e assinatura que permite ao assinante indicar quando, como e onde as notificações de eventos devem ser despachadas. Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos que podem ser acionados por eventos gerados através de ações executadas por esse Conta. Ou seja, a **Conta da Empresa A** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da Empresa B**. São identificados seguindo o padrão **Resource.EventAction**, sendo **Resource** o nome da entidade que gerou o evento e **EventAction** o nome do evento e ação criados. Esses tipos podem ser utilizados como filtro ao criar ou alterar um webhook, sendo que o filtro determina quais notificações de eventos e ação serão enviadas para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros paths: /v2/companies: get: tags: - Companies summary: Consultar todas as Empresas da Conta description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar os dados das empresas vinculadas a conta." operationId: V2CompaniesGet parameters: - name: startingAfter in: query description: 'Id de início do contador (Default: Empty)' schema: type: string - name: endingBefore in: query description: 'Id final do contador (Default: Empty)' schema: type: string - name: limit in: query description: 'Limite de resultados na página (Default: 10)' schema: type: integer format: int32 responses: "200": description: Sucesso na consulta da Empresa content: application/json: schema: type: object properties: companies: type: array description: Lista de Empresa items: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) stateTaxes: type: array description: Lista de Inscrição Estadual items: type: string name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Empresas "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Empresa não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey post: tags: - Companies summary: Criar uma Empresa description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais." operationId: V2CompaniesPost requestBody: description: Dados da Empresa a ser criada content: application/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Criar Empresa text/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Criar Empresa application/*+json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Criar Empresa required: false responses: "200": description: Sucesso na criação da Empresa content: application/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) stateTaxes: type: array description: Lista de Inscrição Estadual items: type: string name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Empresa "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey x-codegen-request-body-name: body /v2/companies/{company_id}: get: tags: - Companies summary: Consultar uma Empresa pelo ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID." operationId: V2CompaniesByCompany_idGet parameters: - name: company_id in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta da Empresa content: application/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) stateTaxes: type: array description: Lista de Inscrição Estadual items: type: string name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Empresa "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Empresa não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey put: tags: - Companies summary: Alterar uma Empresa pelo ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para alterar os dados de uma empresas pelo ID." operationId: V2CompaniesByCompany_idPut parameters: - name: company_id in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string requestBody: description: Dados da Empresa a ser alterada content: application/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Alterar Empresa text/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Alterar Empresa application/*+json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Dados para Alterar Empresa required: false responses: "200": description: Sucesso na alteração da Empresa content: application/json: schema: type: object properties: company: required: - address - federalTaxNumber - name - tradeName type: object properties: id: type: string description: Identificador (gerado automaticamente) stateTaxes: type: array description: Lista de Inscrição Estadual items: type: string name: type: string description: Razão Social accountId: type: string description: Identificador da conta tradeName: type: string description: Nome Fantasia federalTaxNumber: type: integer description: Número de Inscrição Federal (CNPJ) format: int64 taxRegime: type: string description: Regime Tributário enum: - isento - microempreendedorIndividual - simplesNacional - lucroPresumido - lucroReal - none address: required: - city - country - district - number - postalCode - state - street type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' city: required: - code - name type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE name: type: string description: Nome do Município description: Cidade do Endereço district: type: string description: Bairro do Endereço additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' street: type: string description: Logradouro do Endereço number: type: string description: Número do Endereço. Usar S/N para "sem número". postalCode: type: string description: Cód. Endereço Postal (CEP) country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' description: Endereço description: Dados da Empresa description: Empresa "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Empresa não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey x-codegen-request-body-name: body delete: tags: - Companies summary: Excluir uma Empresa por ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível." operationId: V2CompaniesByCompany_idDelete parameters: - name: company_id in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string responses: "204": description: Sucesso na exclusão da Empresa content: {} "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Empresa não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey /v2/companies/{company_id}/certificates: get: tags: - Companies Certificates summary: Consultar um Certificado por seu Status description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__)." operationId: V2CompaniesByCompany_idCertificatesGet parameters: - name: company_id in: path description: ID da Empresa relacionada ao certificado required: true schema: type: string - name: status in: query description: Status do certificado schema: type: string enum: - inactive - overdue - pending - active - none responses: "200": description: Sucesso na consulta content: application/json: schema: type: object properties: certificates: type: array items: type: object properties: subject: type: string description: Nome do certificado (subject distinguished name) validUntil: type: string description: Data no horário local após o qual um certificado não é mais válido format: date-time thumbprint: type: string description: A impressão digital do certificado federalTaxNumber: type: string description: CNPJ da Empresa modifiedOn: type: string description: Data de modificação format: date-time status: type: string description: Status do certificado enum: - inactive - overdue - pending - active - none description: Certificado "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey post: tags: - Companies Certificates summary: Upload de um Certificado description: "### Informações adicionais\r\n\r\nUtilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos.\r\n\r\nO **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web." operationId: V2CompaniesByCompany_idCertificatesPost parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string requestBody: content: multipart/form-data: schema: required: - file - password type: object properties: file: type: string description: Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 format: binary password: type: string description: Senha do certificado ICP-Brasil application/form-data: schema: required: - file - password type: object properties: file: type: string description: Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 format: binary password: type: string description: Senha do certificado ICP-Brasil required: true responses: "200": description: Sucesso no upload e vinculo com a Empresa content: application/json: schema: type: object properties: certificate: type: object properties: subject: type: string description: Nome do certificado (subject distinguished name) validUntil: type: string description: Data no horário local após o qual um certificado não é mais válido format: date-time thumbprint: type: string description: A impressão digital do certificado federalTaxNumber: type: string description: CNPJ da Empresa modifiedOn: type: string description: Data de modificação format: date-time status: type: string description: Status do certificado enum: - inactive - overdue - pending - active - none description: Certificado description: Certificado "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey /v2/companies/{company_id}/certificates/{certificate_thumbprint}: get: tags: - Companies Certificates summary: Consultar um Certificado por sua impressão digital description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__)." operationId: V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet parameters: - name: company_id in: path description: ID da Empresa relacionada ao certificado required: true schema: type: string - name: certificate_thumbprint in: path description: Impressão digital do certificado required: true schema: type: string responses: "200": description: Sucesso na consulta content: application/json: schema: type: object properties: certificate: type: object properties: subject: type: string description: Nome do certificado (subject distinguished name) validUntil: type: string description: Data no horário local após o qual um certificado não é mais válido format: date-time thumbprint: type: string description: A impressão digital do certificado federalTaxNumber: type: string description: CNPJ da Empresa modifiedOn: type: string description: Data de modificação format: date-time status: type: string description: Status do certificado enum: - inactive - overdue - pending - active - none description: Certificado description: Certificado "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Certificado não encontrado content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey delete: tags: - Companies Certificates summary: Excluir um Certificado por sua impressão digital description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**.\r\n\r\n**ATENÇÃO pois esta requisição é irreversível**" operationId: V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete parameters: - name: company_id in: path description: ID da Empresa relacionada ao certificado required: true schema: type: string - name: certificate_thumbprint in: path description: Impressão digital do certificado required: true schema: type: string responses: "204": description: Sucesso na exclusão e desvinculo com a Empresa content: {} "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Certificado não encontrado content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey /v2/companies/{company_id}/statetaxes: get: tags: - Companies State Taxes summary: Listar as Inscrições Estaduais description: "### Informações adicionais\r\n \r\nUtilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ." operationId: V2CompaniesByCompany_idStatetaxesGet parameters: - name: company_id in: path description: ID da Empresa required: true schema: type: string - name: startingAfter in: query description: 'Id de início do contador (Default: Empty)' schema: type: string - name: endingBefore in: query description: 'Id final do contador (Default: Empty)' schema: type: string - name: limit in: query description: 'Limite de resultados na página (Default: 10)' schema: type: integer format: int32 responses: "200": description: Sucesso na criação da Inscrição Estadual content: application/json: schema: type: object properties: stateTaxes: type: array description: Lista de Inscriçoes Estaduais items: required: - number - serie - taxNumber type: object properties: companyId: type: string description: Código da Empresa accountId: type: string description: Account Id status: type: string description: Status no sistema enum: - inactive - none - active series: type: array description: Todas as séries para esta Inscrição Estadual items: type: integer format: int32 createdOn: type: string description: Data de criação format: date-time modifiedOn: type: string description: Data de modificação format: date-time batchId: type: integer description: Número do Lote format: int64 id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey post: tags: - Companies State Taxes summary: Criar uma Inscrição Estadual description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ." operationId: V2CompaniesByCompany_idStatetaxesPost parameters: - name: company_id in: path description: ID da Empresa required: true schema: type: string requestBody: description: Dados da Inscrição Estadual a ser criada content: application/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Criar uma Inscrição Estadual text/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Criar uma Inscrição Estadual application/*+json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Criar uma Inscrição Estadual required: false responses: "200": description: Sucesso na criação da Inscrição Estadual content: application/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: companyId: type: string description: Código da Empresa accountId: type: string description: Account Id status: type: string description: Status no sistema enum: - inactive - none - active series: type: array description: Todas as séries para esta Inscrição Estadual items: type: integer format: int32 createdOn: type: string description: Data de criação format: date-time modifiedOn: type: string description: Data de modificação format: date-time batchId: type: integer description: Número do Lote format: int64 id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados da Inscrição Estadual "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey x-codegen-request-body-name: body /v2/companies/{company_id}/statetaxes/{state_tax_id}: get: tags: - Companies State Taxes summary: Consultar uma Inscrição Estadual pelo ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ." operationId: V2CompaniesByCompany_idStatetaxesByState_tax_idGet parameters: - name: company_id in: path description: ID da Empresa required: true schema: type: string - name: state_tax_id in: path description: ID da Inscrição Estadual que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta da Inscrição Estadual content: application/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: companyId: type: string description: Código da Empresa accountId: type: string description: Account Id status: type: string description: Status no sistema enum: - inactive - none - active series: type: array description: Todas as séries para esta Inscrição Estadual items: type: integer format: int32 createdOn: type: string description: Data de criação format: date-time modifiedOn: type: string description: Data de modificação format: date-time batchId: type: integer description: Número do Lote format: int64 id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados da Inscrição Estadual "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Inscrição Estadual não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey put: tags: - Companies State Taxes summary: Alterar uma Inscrição Estadual pelo ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ." operationId: V2CompaniesByCompany_idStatetaxesByState_tax_idPut parameters: - name: company_id in: path description: ID da Empresa required: true schema: type: string - name: state_tax_id in: path description: ID da Inscrição Estadual que deverá ser retornado required: true schema: type: string requestBody: description: Dados da Inscrição Estadual a ser alterada content: application/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Alterar uma Inscrição Estadual text/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Alterar uma Inscrição Estadual application/*+json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados para Alterar uma Inscrição Estadual required: false responses: "200": description: Sucesso na alteração da Inscrição Estadual content: application/json: schema: type: object properties: stateTax: required: - number - serie - taxNumber type: object properties: companyId: type: string description: Código da Empresa accountId: type: string description: Account Id status: type: string description: Status no sistema enum: - inactive - none - active series: type: array description: Todas as séries para esta Inscrição Estadual items: type: integer format: int32 createdOn: type: string description: Data de criação format: date-time modifiedOn: type: string description: Data de modificação format: date-time batchId: type: integer description: Número do Lote format: int64 id: type: string description: Identificador (gerado automaticamente) code: type: string description: Código do Estado enum: - rO - aC - aM - rR - pA - aP - tO - mA - pI - cE - rN - pB - pE - aL - sE - bA - mG - eS - rJ - sP - pR - sC - rS - mS - mT - gO - dF - eX - nA environmentType: type: string description: Ambiente enum: - none - production - test taxNumber: type: string description: Inscrição Estadual specialTaxRegime: type: string description: Tipo do regime especial de tributação enum: - automatico - nenhum - microempresaMunicipal - estimativa - sociedadeDeProfissionais - cooperativa - microempreendedorIndividual - microempresarioEmpresaPequenoPorte serie: type: integer description: Serie para a emissão NFe format: int32 number: type: integer description: Número para a emissão NFe format: int64 securityCredential: type: object properties: id: type: integer description: Id do código de segurança do contribuinte format: int32 code: type: string description: Código de segurança do contribuinte description: Código de segurança do contribuinte (necessário para emissão de NFCe) type: type: string description: Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe enum: - default - nFe - nFCe description: Dados da Inscrição Estadual description: Dados da Inscrição Estadual "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Inscrição Estadual não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey x-codegen-request-body-name: body delete: tags: - Companies State Taxes summary: Excluir uma Inscrição Estadual pelo ID description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ." operationId: V2CompaniesByCompany_idStatetaxesByState_tax_idDelete parameters: - name: company_id in: path description: ID da Empresa required: true schema: type: string - name: state_tax_id in: path description: ID da Inscrição Estadual que deverá ser retornado required: true schema: type: string responses: "204": description: Sucesso na exclusão da Inscrição Estadual content: {} "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Inscrição Estadual não encontrada content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - apiKey - Authorization_QueryParam: - apiKey /v2/companies/{companyId}/productinvoices: get: tags: - Product Invoices summary: Listar as Notas Fiscais Eletrônicas (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar uma lista de notas fiscais eletrônicas por empresa." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: environment in: query description: Tipo de Ambiente é obrigatório (Production or Test) required: true schema: $ref: '#/components/schemas/EnvironmentType' - name: startingAfter in: query description: 'Id de início do contador (Default: Empty)' schema: type: string - name: endingBefore in: query description: 'Id de fim do contador (Default: Empty)' schema: type: string - name: q in: query description: "Buscar por parâmetros. (\"ElasticSearch string query\") Ex: (q=buyer.name:'EMPRESA LTDA'). Saiba mais\r\nem: https://nfe.io/docs/nota-fiscal-eletronica/integracao-api/consulta-elasticsearch" schema: type: string - name: limit in: query description: 'Limite de resultados na página (Default: 10)' schema: type: integer format: int32 default: 10 responses: "200": description: Sucesso na consulta em lista content: application/json: schema: $ref: '#/components/schemas/ProductInvoicesResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' post: tags: - Product Invoices summary: Emitir uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo\r\nnão garante a emissão do documento fiscal.\r\nPara obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos\r\nutilizar os WebHooks." parameters: - name: companyId in: path description: Empresa ID required: true schema: type: string requestBody: description: Dados da nota fiscal a ser emitida content: application/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' text/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/*+json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' text/xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/*+xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' responses: "202": description: Sucesso ao enfileirar para emissão content: application/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}: get: tags: - Product Invoices summary: Consultar por ID uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal Eletrônica que deverá ser retornada required: true schema: type: string responses: "200": description: Sucesso na consulta content: application/json: schema: $ref: '#/components/schemas/InvoiceResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' delete: tags: - Product Invoices summary: Cancelar uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de cancelamento.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo\r\nnão garante o cancelamento do documento fiscal.\r\nPara obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." parameters: - name: companyId in: path description: Empresa ID required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser cancelada required: true schema: type: string - name: reason in: query description: Motivo do cancelamento schema: type: string responses: "204": description: Sucesso ao enfileirar para cancelamento content: application/json: schema: $ref: '#/components/schemas/RequestCancellationResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/items: get: tags: - Product Invoices summary: Consultar os produtos por ID uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal Eletrônica que deverá ser retornada required: true schema: type: string - name: limit in: query description: 'Limite de resultados na página (Default: 10)' schema: type: integer format: int32 default: 10 - name: startingAfter in: query description: 'Índice de início do contador (Default: 0)' schema: type: integer format: int32 default: 0 responses: "200": description: Sucesso na consulta content: application/json: schema: $ref: '#/components/schemas/InvoiceItemsResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/events: get: tags: - Product Invoices summary: Consultar eventos por ID uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal Eletrônica que deverá ser retornada required: true schema: type: string - name: limit in: query description: 'Limite de resultados na página (Default: 10)' schema: type: integer format: int32 default: 10 - name: startingAfter in: query description: 'Índice de início do contador (Default: 0)' schema: type: integer format: int32 responses: "200": description: Sucesso na consulta content: application/json: schema: $ref: '#/components/schemas/ProductInvoiceEventsResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/pdf: get: tags: - Product Invoices summary: Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE)\r\nem formato de arquivo PDF." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string - name: force in: query description: Força a geração do pdf independente do FlowStatus schema: type: boolean default: false responses: "200": description: Sucesso na consulta do DANFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/xml: get: tags: - Product Invoices summary: Consultar XML da Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma nota fiscal Eletrônica pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do XML da NFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/xml/rejection: get: tags: - Product Invoices summary: Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do XML da NFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/xml-rejection: get: tags: - Product Invoices summary: Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do XML da NFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/xml-epec: get: tags: - Product Invoices summary: Consultar XML da autorização em contingência (EPEC) parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do XML da NFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter: put: tags: - Product Invoices summary: Enviar uma carta de correção para Nota Fiscal Eletrônica (CC-e) description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma carta de correção na Nota Fiscal Eletrônica (NFE).\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo\r\nnão garante a execução do documento fiscal.\r\nPara obter um retorno ao final do processo de carta de correção de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." parameters: - name: companyId in: path description: Empresa ID required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser cancelada required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueueEventResource' text/json: schema: $ref: '#/components/schemas/QueueEventResource' application/*+json: schema: $ref: '#/components/schemas/QueueEventResource' application/xml: schema: $ref: '#/components/schemas/QueueEventResource' text/xml: schema: $ref: '#/components/schemas/QueueEventResource' application/*+xml: schema: $ref: '#/components/schemas/QueueEventResource' responses: "204": description: Sucesso ao enfileirar para cancelamento content: application/json: schema: $ref: '#/components/schemas/RequestCancellationResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/pdf: get: tags: - Product Invoices summary: Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) de Carta de Correção (CC-e) description: "### Informações adicionais\r\nUtilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE)\r\nem formato de arquivo PDF." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do DANFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/xml: get: tags: - Product Invoices summary: Consultar XML da Carta de Correção Eletrônica (CC-e) description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados da carta de correção de uma nota fiscal Eletrônica pelo ID." parameters: - name: companyId in: path description: ID da Empresa que deverá ser retornado required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser retornado required: true schema: type: string responses: "200": description: Sucesso na consulta do XML da NFE content: application/json: schema: $ref: '#/components/schemas/FileResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/{invoiceId}/disablement: post: tags: - Product Invoices summary: Inutilizar uma Nota Fiscal Eletrônica (NFE) description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de inutilização.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo\r\nnão garante a inutilização do documento fiscal.\r\nPara obter um retorno ao final do processo de inutilização de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." parameters: - name: companyId in: path description: Empresa ID required: true schema: type: string - name: invoiceId in: path description: ID da Nota Fiscal que deverá ser inutilizada required: true schema: type: string - name: reason in: query description: Motivo da inutilização schema: type: string responses: "204": description: Sucesso ao enfileirar para inutilização content: application/json: schema: $ref: '#/components/schemas/RequestCancellationResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/productinvoices/disablement: post: tags: - Product Invoices summary: Inutilizar números de nota fiscal description: "### Informações adicionais\r\nCaso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor" parameters: - name: companyId in: path description: ID da Empresa required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DisablementResource' text/json: schema: $ref: '#/components/schemas/DisablementResource' application/*+json: schema: $ref: '#/components/schemas/DisablementResource' application/xml: schema: $ref: '#/components/schemas/DisablementResource' text/xml: schema: $ref: '#/components/schemas/DisablementResource' application/*+xml: schema: $ref: '#/components/schemas/DisablementResource' responses: "200": description: Sucesso content: application/json: schema: $ref: '#/components/schemas/DisablementResource' "400": description: Algum parâmetro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "404": description: Nota Fiscal Eletrônica não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/companies/{companyId}/statetaxes/{statetaxId}/productinvoices: post: tags: - Product Invoices summary: Emitir uma Nota Fiscal Eletrônica (NFE) Informando um StateTaxId description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão.\r\n**ATENÇÃO**: Cada processamento será feito de forma assíncrona, ou seja, o retorno positivo\r\nnão garante a emissão do documento fiscal.\r\nPara obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos\r\nutilizar os WebHooks." parameters: - name: companyId in: path description: Empresa ID required: true schema: type: string - name: statetaxId in: path description: Inscrição Estadual(StateTax) ID required: true schema: type: string requestBody: description: Dados da nota fiscal a ser emitida content: application/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' text/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/*+json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' text/xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' application/*+xml: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' responses: "202": description: Sucesso ao enfileirar para emissão content: application/json: schema: $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "408": description: Tempo limite de 60s excedido no enfileiramento content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' "500": description: Erro no processamento content: application/json: schema: $ref: '#/components/schemas/ErrorsResource' /v2/webhooks/eventtypes: get: tags: - WebHooks summary: Listar os Tipos de Eventos gerados pela plataforma description: "### Informações adicionais\r\n\r\nEventos ocorrem a todo instante na plataforma durante os processamentos e são registrados\r\ncriando notificações para os webhooks ativos e configurados para receber os eventos.\r\n \r\nSão identificados seguindo o padrão **Resource.EventAction**,\r\nonde **Resource**: nome da entidade que gerou o evento;\r\n**EventAction**: nome do evento e ação criados.\r\n\r\nEsse tipos podem ser utilizados como filtro ao criar ou alterar um webhook,\r\nsendo que o filtro determina quais notificações de eventos e ação serão enviadas\r\npara um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook\r\nele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros." responses: "200": description: Sucesso na consulta do tipos de eventos content: application/json: schema: type: object properties: eventTypes: type: array description: Lista de Evento items: type: object properties: id: type: string description: "Identificador do evento, seguem o padrão **Resource.EventAction**.\r\nOnde **Resource**: nome da entidade que gerou o evento;\r\n**EventAction**: nome do evento e ação criados.\r\nAlguns exemplos **Invoice.Issued** ou **Blob.Updated**" description: type: string description: Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. status: type: integer description: WebHook Filter Status format: int32 enum: - 0 - 1 description: Tipo de Evento description: Tipos de Eventos "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess /v2/webhooks: get: tags: - WebHooks summary: Listar os Webhooks description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada." responses: "200": description: Sucesso na consulta da lista content: application/json: schema: type: object properties: webHooks: type: array description: Lista de Web Hook items: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Web Hooks "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess post: tags: - WebHooks summary: Criar um Webhook description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma.\r\n \r\nNa criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada.\r\n \r\nUm **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura*\r\nque permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas.\r\nUm **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos\r\nque podem ser acionados por eventos gerados através de ações executadas por esse Conta.\r\nOu seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**." requestBody: content: application/json-patch+json: schema: type: object properties: webHook: required: - uri type: object properties: uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: Dados para criar um Web Hook description: Dados para criar um Web Hook application/json: schema: type: object properties: webHook: required: - uri type: object properties: uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: Dados para criar um Web Hook description: Dados para criar um Web Hook text/json: schema: type: object properties: webHook: required: - uri type: object properties: uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: Dados para criar um Web Hook description: Dados para criar um Web Hook application/*+json: schema: type: object properties: webHook: required: - uri type: object properties: uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: Dados para criar um Web Hook description: Dados para criar um Web Hook required: false responses: "201": description: Sucesso na criação da webhook content: application/json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Web Hook "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Webhook não encontrado content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess x-codegen-request-body-name: body delete: tags: - WebHooks summary: Excluir Todos os Webhooks existentes description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada." responses: "204": description: Sucesso na exclusão dos WebHooks content: {} "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess /v2/webhooks/{webhook_id}: get: tags: - WebHooks summary: Consultar um webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**." operationId: RegistrationLookupAction parameters: - name: webhook_id in: path description: ID do webhook a ser consultado required: true schema: type: string responses: "200": description: Sucesso na consulta do webhook content: application/json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Web Hook "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Webhook não encontrado content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess put: tags: - WebHooks summary: Alterar um Webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado." parameters: - name: webhook_id in: path description: ID do Webhook a ser atualizado required: true schema: type: string requestBody: description: Dados para alterar o Webhook content: application/json-patch+json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Dados para alterar um Web Hook application/json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Dados para alterar um Web Hook text/json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Dados para alterar um Web Hook application/*+json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Dados para alterar um Web Hook required: false responses: "200": description: Sucesso na atualização da Webhook content: application/json: schema: type: object properties: webHook: required: - uri type: object properties: id: type: string description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." uri: type: string description: A URL onde as notificações dos eventos deverão entregues. secret: type: string description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." contentType: type: integer description: WebHook Media Type format: int32 enum: - 0 - 1 insecureSsl: type: boolean description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." status: type: integer description: WebHook Status format: int32 enum: - 0 - 1 filters: uniqueItems: true type: array description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." items: type: string headers: type: object additionalProperties: type: string description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. properties: type: object additionalProperties: type: object description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." createdOn: type: string description: Data de criação do webhook format: date-time modifiedOn: type: string description: Data de modificação do webhook format: date-time description: WebHook (Notificação HTTP) description: Web Hook "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Webhook não encontrado content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess x-codegen-request-body-name: body delete: tags: - WebHooks summary: Excluir um Webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado.\r\nA exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos." parameters: - name: webhook_id in: path description: ID do Webhook a ser excluído required: true schema: type: string responses: "204": description: Sucesso na exclusão da Webhook content: {} "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Webhook não encontrado content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess /v2/webhooks/{webhook_id}/pings: put: tags: - WebHooks summary: Criar notificação para Testar um webhook description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado.\r\n\r\nEsta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado." parameters: - name: webhook_id in: path description: ID do Webhook a ser testado required: true schema: type: string responses: "204": description: Sucesso ao criar notificação de teste content: {} "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: {} "403": description: Accesso proibido content: {} "404": description: Webhook não encontrado content: {} "500": description: Erro no processamento content: application/json: schema: type: object properties: errors: type: array description: Lista de Erros items: type: object properties: code: type: integer description: Código do erro format: int32 message: type: string description: Mensagem contendo os detalhes do erro description: Erro description: Lista de Erros security: - Authorization_Header: - readAccess - writeAccess Authorization_QueryParam: - readAccess - writeAccess components: schemas: ActivityResource: type: object properties: data: description: Detalhes do Evento nullable: true type: type: string description: Nome do Evento gerado nullable: true sequence: type: integer description: Número sequencial do Evento format: int32 nullable: true additionalProperties: false AdditionResource: type: object properties: code: type: integer description: Numero da adição (nAdicao) format: int64 nullable: true manufacturer: type: string description: Código do fabricante estrangeiro (cFabricante) nullable: true amount: type: number description: Valor do desconto do item da DI – Adição (vDescDI) format: double nullable: true drawback: type: integer description: Número do ato concessório de Drawback (nDraw) format: int64 nullable: true additionalProperties: false description: Adições (adi) AdditionalInformationResource: type: object properties: fisco: type: string description: Informações Adicionais de Interesse do Fisco (infAdFisco) nullable: true taxpayer: type: string description: Informações Complementares de interesse do Contribuinte (infCpl) nullable: true xmlAuthorized: type: array items: type: integer format: int64 description: Informações Complementares de interesse do Contribuinte (infCpl) nullable: true effort: type: string nullable: true order: type: string nullable: true contract: type: string nullable: true taxDocumentsReference: type: array items: $ref: '#/components/schemas/TaxDocumentsReferenceResource' description: Documentos Fiscais Referenciados (refECF) nullable: true taxpayerComments: type: array items: $ref: '#/components/schemas/TaxpayerCommentsResource' description: Observações fiscais (obsCont) nullable: true referencedProcess: type: array items: $ref: '#/components/schemas/ReferencedProcessResource' description: Processos referenciados (procRef) nullable: true additionalProperties: false AddressResource: type: object properties: state: type: string description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' nullable: true city: $ref: '#/components/schemas/CityResource' district: type: string description: Bairro do Endereço nullable: true additionalInformation: type: string description: 'Complemento do Endereço, ex.: AP 2, BL A.' nullable: true street: type: string description: Logradouro do Endereço nullable: true number: type: string description: Número do Endereço. Usar S/N para "sem número". nullable: true postalCode: type: string description: Cód. Endereço Postal (CEP) nullable: true country: type: string description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' nullable: true phone: type: string description: Telefone nullable: true additionalProperties: false description: Dados do Endereço AuthorizationResource: type: object properties: receiptOn: type: string format: date-time nullable: true accessKey: type: string nullable: true message: type: string nullable: true additionalProperties: false BillResource: type: object properties: number: type: string description: Número da Fatura (nFat) nullable: true originalAmount: type: number description: Valor Original da Fatura (vOrig) format: double nullable: true discountAmount: type: number description: Valor do desconto (vDesc) format: double nullable: true netAmount: type: number description: Valor Líquido da Fatura (vLiq) format: double nullable: true additionalProperties: false BillingResource: type: object properties: bill: $ref: '#/components/schemas/BillResource' duplicates: type: array items: $ref: '#/components/schemas/DuplicateResource' description: Grupo Duplicata (dup) nullable: true additionalProperties: false BuyerResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true id: type: string description: Identificação nullable: true name: type: string description: Nome ou Razão Social (xNome) nullable: true federalTaxNumber: type: integer description: CNPJ ou CPF format: int64 nullable: true email: type: string description: Email nullable: true address: $ref: '#/components/schemas/AddressResource' type: $ref: '#/components/schemas/PersonType' stateTaxNumberIndicator: $ref: '#/components/schemas/ReceiverStateTaxIndicator' tradeName: type: string description: Nome fantasia nullable: true taxRegime: $ref: '#/components/schemas/TaxRegime' stateTaxNumber: type: string description: Inscrição Estadual (IE) nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de endereço do Destinatário da NF-e" CIDEResource: type: object properties: bc: type: number description: BC da CIDE (qBCProd) format: double nullable: true rate: type: number description: Valor da alíquota da CIDE (vAliqProd) format: double nullable: true cideAmount: type: number description: Valor da CIDE (vCIDE) format: double nullable: true additionalProperties: false CardResource: type: object properties: federalTaxNumber: type: string description: CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) nullable: true flag: $ref: '#/components/schemas/FlagCard' authorization: type: string description: Número de autorização da operação cartão de crédito e/ou débito (cAut) nullable: true integrationPaymentType: $ref: '#/components/schemas/IntegrationPaymentType' federalTaxNumberRecipient: type: string description: CNPJ do beneficiário do pagamento (CNPJReceb) nullable: true idPaymentTerminal: type: string description: Identificador do terminal de pagamento (idTermPag) nullable: true additionalProperties: false CityResource: type: object properties: code: type: string description: Cód. do Município, segundo o Tabela de Municípios do IBGE nullable: true name: type: string description: Nome do Município nullable: true additionalProperties: false CofinsTaxResource: type: object properties: cst: type: string description: Código de Situação Tributária da COFINS nullable: true baseTax: type: number description: Valor da Base de Cálculo da COFINS (vBC) format: double nullable: true rate: type: number description: Alíquota da COFINS (em percentual) (pCOFINS) format: double nullable: true amount: type: number description: Valor da COFINS (vCOFINS) format: double nullable: true baseTaxProductQuantity: type: number description: Quantidade Vendida (qBCProd) format: double nullable: true productRate: type: number description: Alíquota da COFINS (em reais) (vAliqProd) format: double nullable: true additionalProperties: false description: "Grupo do COFINS\r\n\r\nID: S01\r\nPai: M01\r\n\r\n Obs: Informar apenas um dos grupos S02, S03, S04 ou S04\r\n com base valor atribuído ao campo S06 – CST do COFINS\r\n" ConsumerPresenceType: enum: - None - Presence - Internet - Telephone - Delivery - OthersNonPresenceOperation type: string description: Indicador de Presença (indPres ) ConsumerType: enum: - FinalConsumer - Normal type: string description: Indica operação com Consumidor final (indFinal) ContingencyDetails: type: object properties: authorizer: $ref: '#/components/schemas/StateTaxProcessingAuthorizer' startedOn: type: string description: Data e hora do início da contingência format: date-time reason: type: string description: Justificativa da entrada em contingência nullable: true additionalProperties: false DeliveryInformationResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true id: type: string description: Identificação nullable: true name: type: string description: Nome ou Razão Social (xNome) nullable: true federalTaxNumber: type: integer description: CNPJ ou CPF format: int64 nullable: true email: type: string description: Email nullable: true address: $ref: '#/components/schemas/AddressResource' type: $ref: '#/components/schemas/PersonType' stateTaxNumber: type: string description: Inscrição Estadual (IE) nullable: true additionalProperties: false description: Identificação do Local de entrega (entrega) Destination: enum: - None - Internal_Operation - Interstate_Operation - International_Operation type: string description: Identificador de local de destino da operação (idDest) DisablementResource: type: object properties: environment: $ref: '#/components/schemas/EnvironmentType' serie: type: integer description: Série format: int32 state: $ref: '#/components/schemas/StateCode' beginNumber: type: integer description: Número inicial format: int32 lastNumber: type: integer description: Número final (usar o mesmo número inicial se for apenas um número) format: int32 reason: type: string description: Motivo da inutilização nullable: true additionalProperties: false description: Dados para inutilizar números de nota fiscal DocumentElectronicInvoiceResource: type: object properties: accessKey: type: string description: Chave de Acesso (refNFe) nullable: true additionalProperties: false DocumentInvoiceReferenceResource: type: object properties: state: type: number description: Código da UF (cUF) format: double nullable: true yearMonth: type: string description: Ano / Mês (AAMM) nullable: true federalTaxNumber: type: string description: CNPJ (CNPJ) nullable: true model: type: string description: Modelo (mod) nullable: true series: type: string description: Série (serie) nullable: true number: type: string description: Número (nNF) nullable: true additionalProperties: false DuductionIndicator: enum: - NotDeduct - Deduce type: string description: Indicador de intermediador/marketplace (indIntermed) DuplicateResource: type: object properties: number: type: string description: Número da Duplicata (nDup) nullable: true expirationOn: type: string description: Data de vencimento (dVenc) format: date-time nullable: true amount: type: number description: Valor da duplicata (vDup) format: double nullable: true additionalProperties: false EconomicActivityResource: type: object properties: type: $ref: '#/components/schemas/EconomicActivityType' code: type: integer description: Código da Atividade da Empresa format: int32 nullable: true additionalProperties: false EconomicActivityType: enum: - Main - Secondary type: string EnvironmentType: enum: - None - Production - Test type: string ErrorResource: type: object properties: code: type: integer format: int32 nullable: true message: type: string nullable: true additionalProperties: false ErrorsResource: type: object properties: errors: type: array items: $ref: '#/components/schemas/ErrorResource' nullable: true readOnly: true additionalProperties: false ExemptReason: enum: - Agriculture - Others - DevelopmentEntities type: string description: "Campo será preenchido quando o campo anterior estiver\r\npreenchido.Informar o motivo da desoneração:" ExportDetailResource: type: object properties: drawback: type: string description: Número do ato concessório de Drawback (nDraw) nullable: true hintInformation: $ref: '#/components/schemas/ExportHintResource' additionalProperties: false ExportHintResource: type: object properties: registryId: type: string description: Número do Registro de Exportação (nRE) nullable: true accessKey: type: string description: Chave de Acesso da NF-e recebida para exportação (chNFe) nullable: true quantity: type: number description: Quantidade do item realmente exportado (qExport) format: double nullable: true additionalProperties: false ExportResource: type: object properties: state: $ref: '#/components/schemas/StateCode' office: type: string description: Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) nullable: true local: type: string description: Informações Complementares de interesse do Contribuinte (xLocDespacho) nullable: true additionalProperties: false FileResource: type: object properties: uri: type: string description: Endereço Absoluto URI para o arquivo nullable: true additionalProperties: false description: Arquivo FlagCard: enum: - None - Visa - Mastercard - AmericanExpress - Sorocred - DinersClub - Elo - Hipercard - Aura - Cabal - Alelo - BanesCard - CalCard - Credz - Discover - GoodCard - GreenCard - Hiper - JCB - Mais - MaxVan - Policard - RedeCompras - Sodexo - ValeCard - Verocheque - VR - Ticket - Other type: string FuelOriginResource: type: object properties: indImport: type: integer description: Indicador de importação (indImport) format: int32 nullable: true cUFOrig: type: integer description: Código da UF (cUFOrig) format: int32 nullable: true pOrig: type: number description: Percentual originário para a UF (pOrig) format: double nullable: true additionalProperties: false FuelResource: type: object properties: codeANP: type: string description: Código de produto da ANP (cProdANP) nullable: true percentageNG: type: number description: Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) format: double nullable: true descriptionANP: type: string description: Descrição do produto conforme ANP (descANP) nullable: true percentageGLP: type: number description: Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) format: double nullable: true percentageNGn: type: number description: Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) format: double nullable: true percentageGNi: type: number description: Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) format: double nullable: true startingAmount: type: number description: Valor de partida (cProdANP=210203001) (vPart) format: double nullable: true codif: type: string description: Código de autorização / registro do CODIF (CODIF) nullable: true amountTemp: type: number description: Quantidade de combustível faturada à temperatura ambiente (qTemp) format: double nullable: true stateBuyer: type: string description: Sigla da UF de consumo (UFCons) nullable: true cide: $ref: '#/components/schemas/CIDEResource' pump: $ref: '#/components/schemas/PumpResource' fuelOrigin: $ref: '#/components/schemas/FuelOriginResource' additionalProperties: false ICMSTotal: type: object properties: baseTax: type: number description: Base de Cálculo do ICMS (vBC) format: double nullable: true icmsAmount: type: number description: Valor Total do ICMS (vICMS) format: double nullable: true icmsExemptAmount: type: number description: Valor ICMS Total desonerado (vICMSDeson) format: double nullable: true stCalculationBasisAmount: type: number description: Base de Cálculo do ICMS Substituição Tributária (vBCST) format: double nullable: true stAmount: type: number description: Valor Total do ICMS ST (vST) format: double nullable: true productAmount: type: number description: Valor Total dos produtos e serviços (vProd) format: double freightAmount: type: number description: Valor Total do Frete (vFrete) format: double nullable: true insuranceAmount: type: number description: Valor Total do Seguro (vSeg) format: double nullable: true discountAmount: type: number description: Valor Total do Desconto (vDesc) format: double nullable: true iiAmount: type: number description: Valor Total do Imposto de Importação (vII) format: double nullable: true ipiAmount: type: number description: Valor Total do IPI (vIPI) format: double nullable: true pisAmount: type: number description: Valor do PIS (vPIS) format: double nullable: true cofinsAmount: type: number description: Valor do COFINS (vCOFINS) format: double nullable: true othersAmount: type: number description: Outras Despesas acessórias (vOutro) format: double nullable: true invoiceAmount: type: number description: Valor Total da NF-e (vNF) format: double fcpufDestinationAmount: type: number description: Valor Total ICMS FCP UF Destino format: double nullable: true icmsufDestinationAmount: type: number description: Valor Total ICMS Interestadual UF Destino format: double nullable: true icmsufSenderAmount: type: number description: Valor Total ICMS Interestadual UF Rem. format: double nullable: true federalTaxesAmount: type: number description: Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) format: double fcpAmount: type: number description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) format: double nullable: true fcpstAmount: type: number description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido por substituição tributária. format: double nullable: true fcpstRetAmount: type: number description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido anteriormente por substituição tributária. format: double nullable: true ipiDevolAmount: type: number description: Valor total do IPI devolvido (vIPIDevol) format: double nullable: true qBCMono: type: number format: double nullable: true vICMSMono: type: number description: Valor total do ICMS monofásico próprio (vICMSMono). format: double nullable: true qBCMonoReten: type: number description: Valor total da quantidade tributada do ICMS monofásico sujeito a retenção (qBCMonoReten). format: double nullable: true vICMSMonoReten: type: number description: Valor total da quantidade tributada do ICMS monofásico retido anteriormente(vICMSMonoReten) format: double nullable: true qBCMonoRet: type: number description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) format: double nullable: true vICMSMonoRet: type: number description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) format: double nullable: true additionalProperties: false description: "Manual Contribuinte v_5.00\r\nGrupo de Valores Totais referentes ao ICMS" ICMSTotalResource: type: object properties: baseTax: type: number description: Base de Cálculo do ICMS (vBC) format: double nullable: true icmsAmount: type: number description: Valor Total do ICMS (vICMS) format: double nullable: true icmsExemptAmount: type: number description: Valor ICMS Total desonerado (vICMSDeson) format: double nullable: true stCalculationBasisAmount: type: number description: Base de Cálculo do ICMS Substituição Tributária (vBCST) format: double nullable: true stAmount: type: number description: Valor Total do ICMS ST (vST) format: double nullable: true productAmount: type: number description: Valor Total dos produtos e serviços (vProd) format: double nullable: true freightAmount: type: number description: Valor Total do Frete (vFrete) format: double nullable: true insuranceAmount: type: number description: Valor Total do Seguro (vSeg) format: double nullable: true discountAmount: type: number description: Valor Total do Desconto (vDesc) format: double nullable: true iiAmount: type: number description: Valor Total do Imposto de Importação (vII) format: double nullable: true ipiAmount: type: number description: Valor Total do IPI (vIPI) format: double nullable: true pisAmount: type: number description: Valor do PIS (vPIS) format: double nullable: true cofinsAmount: type: number description: Valor do COFINS (vCOFINS) format: double nullable: true othersAmount: type: number description: Outras Despesas acessórias (vOutro) format: double nullable: true invoiceAmount: type: number description: Valor Total da NF-e (vNF) format: double nullable: true fcpufDestinationAmount: type: number description: Valor Total ICMS FCP UF Destino (vFCPUFDest) format: double nullable: true icmsufDestinationAmount: type: number description: Valor Total ICMS Interestadual UF Destino (vICMSUFDest) format: double nullable: true icmsufSenderAmount: type: number description: Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) format: double nullable: true federalTaxesAmount: type: number description: Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) format: double nullable: true fcpAmount: type: number description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) format: double nullable: true fcpstAmount: type: number description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) format: double nullable: true fcpstRetAmount: type: number description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) format: double nullable: true ipiDevolAmount: type: number description: Valor total do IPI devolvido (vIPIDevol) format: double nullable: true qBCMono: type: number description: Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) format: double nullable: true vICMSMono: type: number description: Valor total do ICMS monofásico próprio (vICMSMono) format: double nullable: true qBCMonoReten: type: number description: Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) format: double nullable: true vICMSMonoReten: type: number description: Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) format: double nullable: true qBCMonoRet: type: number description: Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) format: double nullable: true vICMSMonoRet: type: number description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) format: double nullable: true additionalProperties: false description: "Manual Contribuinte v_5.00\r\nGrupo de Valores Totais referentes ao ICMS" ICMSUFDestinationTaxResource: type: object properties: vBCUFDest: type: number description: Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) format: double nullable: true pFCPUFDest: type: number description: Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest) format: double nullable: true pICMSUFDest: type: number description: Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) format: double nullable: true pICMSInter: type: number description: Alíquota interestadual das UF envolvidas (pICMSInter) format: double nullable: true pICMSInterPart: type: number description: Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) format: double nullable: true vFCPUFDest: type: number description: Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest format: double nullable: true vICMSUFDest: type: number description: Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) format: double nullable: true vICMSUFRemet: type: number description: Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) format: double nullable: true vBCFCPUFDest: type: number description: Valor da BC FCP na UF de destino (vBCFCPUFDest) format: double nullable: true additionalProperties: false description: Grupo de Tributação do ICMS de Destino da UF IITaxResource: type: object properties: baseTax: type: string description: Valor BC do Imposto de Importação (vBC) nullable: true customsExpenditureAmount: type: string description: Valor despesas aduaneiras (vDespAdu) nullable: true amount: type: number description: Valor Imposto de Importação (vII) format: double nullable: true iofAmount: type: number description: Valor Imposto sobre Operações Financeiras (vIOF) format: double nullable: true vEnqCamb: type: number description: Valor dos encargos cambiais format: double nullable: true additionalProperties: false description: "Grupo do Imposto de Importação\r\n\r\nId: P01\r\nPai: O01" IPITaxResource: type: object properties: cst: type: string description: Código da situação tributária do IPI (CST) nullable: true classificationCode: type: string description: Código de Enquadramento Legal do IPI (cEnq) nullable: true classification: type: string description: "clEnq\r\nClasse de enquadramento do IPI para Cigarros e Bebidas (clEnq)" nullable: true producerCNPJ: type: string description: CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) nullable: true stampCode: type: string description: Código do selo de controle IPI (cSelo) nullable: true stampQuantity: type: number description: Quantidade de selo de controle (qSelo) format: double nullable: true base: type: number description: Valor da BC do IPI (vBC) format: double nullable: true rate: type: number description: Alíquota do IPI (pIPI) format: double nullable: true unitQuantity: type: number description: Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid) format: double nullable: true unitAmount: type: number description: Valor por Unidade Tributável (vUnid) format: double nullable: true amount: type: number description: Valor IPI (vIPI) format: double nullable: true additionalProperties: false description: "\r\nGrupo do IPI\r\n\r\nInformar apenas quando o item for sujeito ao IPI\r\n\r\nID: O01\r\n\r\nPai: M01" ISSQNTotal: type: object properties: totalServiceNotTaxedICMS: type: number description: Valor Total Serv.Não Tributados p/ ICMS format: double nullable: true baseRateISS: type: number description: Base de Cálculo do ISS format: double nullable: true totalISS: type: number description: Valor Total do ISS format: double nullable: true valueServicePIS: type: number description: Valor do PIS sobre Serviços format: double nullable: true valueServiceCOFINS: type: number description: Valor da COFINS sobre Serviços format: double nullable: true provisionService: type: string description: Data Prestação Serviço format: date-time nullable: true deductionReductionBC: type: number description: Valor Dedução para Redução da BC format: double nullable: true valueOtherRetention: type: number description: Valor Outras Retenções format: double nullable: true discountUnconditional: type: number description: Valor Desconto Incondicionado format: double nullable: true discountConditioning: type: number description: Valor Desconto Condicionado format: double nullable: true totalRetentionISS: type: number description: Valor Total Retenção ISS format: double nullable: true codeTaxRegime: type: number description: Código Regime Tributação format: double nullable: true additionalProperties: false ISSQNTotalResource: type: object properties: totalServiceNotTaxedICMS: type: number description: Valor Total Serv.Não Tributados p/ ICMS (vServ) format: double nullable: true baseRateISS: type: number description: Base de Cálculo do ISS (vBC) format: double nullable: true totalISS: type: number description: Valor Total do ISS (vISS) format: double nullable: true valueServicePIS: type: number description: Valor do PIS sobre Serviços (vPIS) format: double nullable: true valueServiceCOFINS: type: number description: Valor da COFINS sobre Serviços (vCOFINS) format: double nullable: true provisionService: type: string description: Data Prestação Serviço (dCompet) format: date-time nullable: true deductionReductionBC: type: number description: Valor Dedução para Redução da BC (vDeducao) format: double nullable: true valueOtherRetention: type: number description: Valor Outras Retenções (vOutro) format: double nullable: true discountUnconditional: type: number description: Valor Desconto Incondicionado (vDescIncond) format: double nullable: true discountConditioning: type: number description: Valor Desconto Condicionado (vDescCond) format: double nullable: true totalRetentionISS: type: number description: Valor Total Retenção ISS (vISSRet) format: double nullable: true codeTaxRegime: type: number description: Código Regime Tributação (cRegTrib) format: double nullable: true additionalProperties: false IcmsTaxResource: type: object properties: origin: type: string description: Origem da mercadoria (orig) nullable: true cst: type: string description: Tributação do ICMS (CST) nullable: true csosn: type: string description: "101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN)\r\nCódigo de Situação da Operação – Simples Nacional" nullable: true baseTaxModality: type: string description: "Modalidade de determinação da BC do ICMS (modBC)\r\n\r\n Margem Valor Agregado (%) = 0\r\n Pauta (valor) = 1\r\n Preço Tabelado Máximo (valor) = 2\r\n Valor da Operação = 3\r\n" nullable: true baseTax: type: number description: Valor da BC do ICMS (vBC) format: double nullable: true baseTaxSTModality: type: string description: Modalidade de determinação da BC do ICMS ST (modBCST) nullable: true baseTaxSTReduction: type: string description: "pRedBCST\r\nPercentual da Redução de BC do ICMS ST (pRedBCST)" nullable: true baseTaxST: type: number description: Valor da BC do ICMS ST (vBCST) format: double nullable: true baseTaxReduction: type: number description: Percentual da Redução de BC (pRedBC) format: double nullable: true stRate: type: number description: Alíquota do imposto do ICMS ST (pICMSST) format: double nullable: true stAmount: type: number description: Valor do ICMS ST (vICMSST) format: double nullable: true stMarginAmount: type: number description: "pMVAST\r\nPercentual da margem de valor Adicionado do ICMS ST (pMVAST)" format: double nullable: true rate: type: number description: "pICMS\r\nAlíquota do imposto (pICMS)" format: double nullable: true amount: type: number description: "Valor do ICMS (vICMS)\r\nO valor do ICMS desonerado será informado apenas nas operações:\r\na) com produtos beneficiados com a desoneração condicional do ICMS.\r\nb) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção.\r\nc) de venda a órgãos da administração pública direta e suas fundações e\r\nautarquias com isenção do ICMS. (NT 2011/004)" format: double nullable: true percentual: type: number description: Percentual da Redução de BC (pICMS) format: double nullable: true snCreditRate: type: number description: Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) format: double nullable: true snCreditAmount: type: number description: Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN) format: double nullable: true stMarginAddedAmount: type: string description: Percentual da margem de valor Adicionado do ICMS ST (pMVAST) nullable: true stRetentionAmount: type: string description: Valor do ICMS ST retido (vICMSSTRet) nullable: true baseSTRetentionAmount: type: string description: Valor da BC do ICMS ST retido (vBCSTRet) nullable: true baseTaxOperationPercentual: type: string description: "Percentual da BC operação própria (pBCOp)\r\nPercentual para determinação do valor da Base de Cálculo da operação própria. (v2.0)" nullable: true ufst: type: string description: "UF para qual é devido o ICMS ST (UFST)\r\nSigla da UF para qual é devido o ICMS ST da operação. (v2.0)" nullable: true amountSTReason: type: string description: Motivo Desoneração ICMS nullable: true baseSNRetentionAmount: type: string description: Valor da BC do ICMS ST retido (vBCSTRet) nullable: true snRetentionAmount: type: string description: Valor do ICMS ST retido (vICMSSTRet) nullable: true amountOperation: type: string description: Valor do ICMS da Operação (vICMSOp) nullable: true percentualDeferment: type: string description: Percentual do Diferimento (pDif) nullable: true baseDeferred: type: string description: Valor do ICMS Diferido (vICMSDif) nullable: true exemptAmount: type: number description: Valor ICMS Desonerado format: double nullable: true exemptReason: $ref: '#/components/schemas/ExemptReason' exemptAmountST: type: number description: Valor ICMS Desonerado format: double nullable: true exemptReasonST: $ref: '#/components/schemas/ExemptReason' fcpRate: type: number description: Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) format: double nullable: true fcpAmount: type: number description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) format: double nullable: true fcpstRate: type: number description: Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST) format: double nullable: true fcpstAmount: type: number description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) format: double nullable: true fcpstRetRate: type: number description: Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) format: double nullable: true fcpstRetAmount: type: number description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) format: double nullable: true baseTaxFCPSTAmount: type: number description: Informar o valor da Base de Cálculo do FCP (vBCFCPST) format: double nullable: true substituteAmount: type: number description: 'Valor do ICMS próprio do Substituto (tag: vICMSSubstituto)' format: double nullable: true stFinalConsumerRate: type: number description: "N26a - Alíquota suportada pelo Consumidor Final (pST)\r\nDeve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria" format: double nullable: true effectiveBaseTaxReductionRate: type: number description: N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet) format: double nullable: true effectiveBaseTaxAmount: type: number description: N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet) format: double nullable: true effectiveRate: type: number description: N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) format: double nullable: true effectiveAmount: type: number description: N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) format: double nullable: true deductionIndicator: $ref: '#/components/schemas/DuductionIndicator' additionalProperties: false description: "Grupo do ICMS da Operação própria e ST\r\n\r\nID: N01\r\nPAI: M01\r\n\r\n Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10,\r\n N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0)\r\n" ImportDeclarationResource: type: object properties: code: type: string description: Número do Documento de Importação da DI/DSI/DA (nDI) nullable: true registeredOn: type: string description: Data de Registro da DI/DSI/DA (dDI) format: date-time nullable: true customsClearanceName: type: string description: Local de desembaraço (xLocDesemb) nullable: true customsClearanceState: $ref: '#/components/schemas/StateCode' customsClearancedOn: type: string description: Data do Desembaraço Aduaneiro (dDesemb) format: date-time nullable: true additions: type: array items: $ref: '#/components/schemas/AdditionResource' description: Adições (adi) nullable: true exporter: type: string description: Código do exportador (cExportador) nullable: true internationalTransport: $ref: '#/components/schemas/InternationalTransportType' intermediation: $ref: '#/components/schemas/IntermediationType' acquirerFederalTaxNumber: type: string description: CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) nullable: true stateThird: type: string description: Sigla da UF do adquirente ou do encomendante (UFTerceiro) nullable: true additionalProperties: false description: Declaração Importação (DI) IntegrationPaymentType: enum: - Integrated - NotIntegrated type: string description: "1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico)\r\n2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS);" IntermediateResource: type: object properties: federalTaxNumber: type: integer description: CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ) format: int64 nullable: true identifier: type: string description: Identificador cadastrado no intermediador (idCadIntTran) nullable: true additionalProperties: false description: Grupo de Informações do Intermediador da Transação (infIntermed) IntermediationType: enum: - None - ByOwn - ImportOnBehalf - ByOrder type: string description: Tipo de Intermediação InternationalTransportType: enum: - None - Maritime - River - Lake - Airline - Postal - Railway - Highway - Network - Own - Ficta - Courier - Handcarry type: string description: Tipo Transporte Internacional InvoiceEventsResourceBase: type: object properties: events: type: array items: $ref: '#/components/schemas/ActivityResource' description: Lista de Eventos ocorridos na Nota Fiscal nullable: true hasMore: type: boolean description: Identificador de possibilidade de mais itens. nullable: true additionalProperties: false InvoiceItemResource: type: object properties: code: type: string description: Código do produto ou serviço (cProd) nullable: true codeGTIN: type: string description: "GTIN (Global Trade Item Number) do produto,\r\nantigo código EAN ou código de barras (cEAN)" nullable: true description: type: string description: Descrição do produto ou serviço (xProd) nullable: true ncm: type: string description: Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) nullable: true nve: type: array items: type: string description: Nomenclatura de Valor aduaneiro e Estatístico (NVE) nullable: true extipi: type: string description: Código Exceção da Tabela de IPI nullable: true cfop: type: integer description: Código Fiscal de Operações e Prestações (CFOP) format: int64 nullable: true unit: type: string description: Unidade Comercial (uCom) nullable: true quantity: type: number description: Quantidade Comercial (qCom) format: double nullable: true unitAmount: type: number description: Valor Unitário de Comercialização (vUnCom) format: double nullable: true totalAmount: type: number description: Valor Total Bruto dos Produtos ou Serviços (vProd) format: double nullable: true codeTaxGTIN: type: string description: "GTIN (Global Trade Item Number) da unidade tributável,\r\nantigo código EAN ou código de barras (cEANTrib)" nullable: true unitTax: type: string description: Unidade Tributável (uTrib) nullable: true quantityTax: type: number description: Quantidade Tributável (qTrib) format: double nullable: true taxUnitAmount: type: number description: Valor Unitário de tributação (vUnTrib) format: double nullable: true freightAmount: type: number description: Valor Total do Frete (vFrete) format: double nullable: true insuranceAmount: type: number description: Valor Total do Seguro (vSeg) format: double nullable: true discountAmount: type: number description: Valor do Desconto (vDesc) format: double nullable: true othersAmount: type: number description: Outras despesas acessórias (vOutro) format: double nullable: true totalIndicator: type: boolean description: "Indica se valor do Item (vProd)\r\nentra no valor total da NF-e (vProd) (indTot)" nullable: true cest: type: string description: CEST - Código especificador da substituição tributária nullable: true tax: $ref: '#/components/schemas/InvoiceItemTaxResource' additionalInformation: type: string description: Informações Adicionais do Produto (infAdProd) nullable: true numberOrderBuy: type: string description: Número do pedido de compra (xPed) nullable: true itemNumberOrderBuy: type: integer description: Item do Pedido de Compra (nItemPed) format: int32 nullable: true importControlSheetNumber: type: string description: Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) nullable: true fuelDetail: $ref: '#/components/schemas/FuelResource' benefit: type: string description: Código de Benefício Fiscal na UF aplicado ao item (cBenef) nullable: true importDeclarations: type: array items: $ref: '#/components/schemas/ImportDeclarationResource' description: Declaração Importação (DI) nullable: true exportDetails: type: array items: $ref: '#/components/schemas/ExportDetailResource' description: Grupo de informações de exportação para o item (detExport) nullable: true taxDetermination: $ref: '#/components/schemas/TaxDeterminationResource' additionalProperties: false description: "Manual Contribuinte v_5.00\r\nGrupo do detalhamento de Produtos e Serviços da NF-e" InvoiceItemTaxResource: type: object properties: totalTax: type: number description: Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) format: double nullable: true icms: $ref: '#/components/schemas/IcmsTaxResource' ipi: $ref: '#/components/schemas/IPITaxResource' ii: $ref: '#/components/schemas/IITaxResource' pis: $ref: '#/components/schemas/PISTaxResource' cofins: $ref: '#/components/schemas/CofinsTaxResource' icmsDestination: $ref: '#/components/schemas/ICMSUFDestinationTaxResource' additionalProperties: false InvoiceItemsResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true companyId: type: string description: Identificador da Empresa nullable: true id: type: string description: Identificador da Nota Fiscal nullable: true items: type: array items: $ref: '#/components/schemas/InvoiceItemResource' description: Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal nullable: true hasMore: type: boolean description: Identifica se existem mais items a serem consultados nullable: true additionalProperties: false InvoiceResource: type: object properties: id: type: string description: Identificador único nullable: true serie: type: integer description: Série do Documento Fiscal (serie) format: int32 nullable: true number: type: integer description: Número do Documento Fiscal (nNF) format: int64 nullable: true status: $ref: '#/components/schemas/InvoiceStatus' authorization: $ref: '#/components/schemas/AuthorizationResource' contingencyDetails: $ref: '#/components/schemas/ContingencyDetails' operationNature: type: string description: Descrição da Natureza da Operação (natOp) nullable: true createdOn: type: string description: Data de criação format: date-time nullable: true modifiedOn: type: string description: Data de modificação format: date-time nullable: true operationOn: type: string description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" format: date-time nullable: true operationType: $ref: '#/components/schemas/OperationType' environmentType: $ref: '#/components/schemas/EnvironmentType' purposeType: $ref: '#/components/schemas/PurposeType' issuer: $ref: '#/components/schemas/IssuerResource' buyer: $ref: '#/components/schemas/BuyerResource' totals: $ref: '#/components/schemas/TotalResource' transport: $ref: '#/components/schemas/TransportInformationResource' additionalInformation: $ref: '#/components/schemas/AdditionalInformationResource' export: $ref: '#/components/schemas/ExportResource' billing: $ref: '#/components/schemas/BillingResource' payment: type: array items: $ref: '#/components/schemas/PaymentResource' description: Grupo de Formas de Pagamento (pag) nullable: true transactionIntermediate: $ref: '#/components/schemas/IntermediateResource' delivery: $ref: '#/components/schemas/DeliveryInformationResource' withdrawal: $ref: '#/components/schemas/WithdrawalInformationResource' lastEvents: $ref: '#/components/schemas/InvoiceEventsResourceBase' additionalProperties: false InvoiceStatus: enum: - None - Created - Processing - Issued - IssuedContingency - Cancelled - Disabled - IssueDenied - Error type: string InvoiceWithoutEventsResource: type: object properties: id: type: string description: Identificador único nullable: true serie: type: integer description: Série do Documento Fiscal (serie) format: int32 nullable: true number: type: integer description: Número do Documento Fiscal (nNF) format: int64 nullable: true status: $ref: '#/components/schemas/InvoiceStatus' authorization: $ref: '#/components/schemas/AuthorizationResource' contingencyDetails: $ref: '#/components/schemas/ContingencyDetails' operationNature: type: string description: Descrição da Natureza da Operação (natOp) nullable: true createdOn: type: string description: Data de criação format: date-time nullable: true modifiedOn: type: string description: Data de modificação format: date-time nullable: true operationOn: type: string description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" format: date-time nullable: true operationType: $ref: '#/components/schemas/OperationType' environmentType: $ref: '#/components/schemas/EnvironmentType' purposeType: $ref: '#/components/schemas/PurposeType' issuer: $ref: '#/components/schemas/IssuerResource' buyer: $ref: '#/components/schemas/BuyerResource' totals: $ref: '#/components/schemas/TotalResource' transport: $ref: '#/components/schemas/TransportInformationResource' additionalInformation: $ref: '#/components/schemas/AdditionalInformationResource' export: $ref: '#/components/schemas/ExportResource' billing: $ref: '#/components/schemas/BillingResource' payment: type: array items: $ref: '#/components/schemas/PaymentResource' description: Grupo de Formas de Pagamento (pag) nullable: true transactionIntermediate: $ref: '#/components/schemas/IntermediateResource' delivery: $ref: '#/components/schemas/DeliveryInformationResource' withdrawal: $ref: '#/components/schemas/WithdrawalInformationResource' additionalProperties: false IssuerFromRequestResource: type: object properties: stStateTaxNumber: type: string description: IE do Substituto Tributário (IEST) nullable: true additionalProperties: false IssuerResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true id: type: string description: Identificação nullable: true name: type: string description: Nome ou Razão Social (xNome) nullable: true federalTaxNumber: type: integer description: CNPJ ou CPF format: int64 nullable: true email: type: string description: Email nullable: true address: $ref: '#/components/schemas/AddressResource' type: $ref: '#/components/schemas/PersonType' tradeName: type: string description: Nome Fantasia nullable: true openningDate: type: string description: Data abertura da empresa format: date-time nullable: true taxRegime: $ref: '#/components/schemas/TaxRegime' specialTaxRegime: $ref: '#/components/schemas/SpecialTaxRegime' legalNature: $ref: '#/components/schemas/LegalNature' economicActivities: type: array items: $ref: '#/components/schemas/EconomicActivityResource' description: Atividades da Empresa (CNAE) nullable: true companyRegistryNumber: type: integer description: Número de Inscrição na Junta Comercial format: int64 nullable: true regionalTaxNumber: type: integer description: Número de Inscrição na SEFAZ (IE) format: int64 nullable: true regionalSTTaxNumber: type: integer description: Inscrição Estadual do Substituto Tributário (IEST) format: int64 nullable: true municipalTaxNumber: type: string description: Número de Inscrição na Prefeitura (IM/CCM) nullable: true stStateTaxNumber: type: string description: IE do Substituto Tributário (IEST) nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de identificação do emitente da NF-e" LegalNature: enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string OperationType: enum: - Outgoing - Incoming type: string PISTaxResource: type: object properties: cst: type: string description: Código de Situação Tributária do PIS (CST) nullable: true baseTax: type: number description: Valor da Base de Cálculo do PIS (vBC) format: double nullable: true rate: type: number description: Alíquota do PIS (em percentual) (pPIS) format: double nullable: true amount: type: number description: Valor do PIS (vPIS) format: double nullable: true baseTaxProductQuantity: type: number description: Quantidade Vendida (qBCProd) format: double nullable: true productRate: type: number description: Alíquota do PIS (em reais) (vAliqProd) format: double nullable: true additionalProperties: false description: Grupo do PIS PaymentDetailResource: type: object properties: method: $ref: '#/components/schemas/PaymentMethod' methodDescription: type: string description: Descrição do meio de pagamento (xPag) nullable: true paymentType: $ref: '#/components/schemas/PaymentType' amount: type: number description: Valor do Pagamento (vPag) format: double nullable: true card: $ref: '#/components/schemas/CardResource' paymentDate: type: string description: Data do pagamento (dPag) format: date-time nullable: true federalTaxNumberPag: type: string description: CNPJ transacional do pagamento (CNPJPag) nullable: true statePag: type: string description: UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) nullable: true additionalProperties: false PaymentMethod: enum: - Cash - Cheque - CreditCard - DebitCard - StoreCredict - FoodVouchers - MealVouchers - GiftVouchers - FuelVouchers - BankBill - BankDeposit - InstantPayment - WireTransfer - Cashback - WithoutPayment - Others type: string PaymentResource: type: object properties: paymentDetail: type: array items: $ref: '#/components/schemas/PaymentDetailResource' description: "YA01a - Grupo Detalhamento da Forma de Pagamento (detPag)\r\nVERSÃO 4.00" nullable: true payBack: type: number description: "Valor do troco (vTroco)\r\nVERSÃO 4.00" format: double nullable: true additionalProperties: false PaymentType: enum: - InCash - Term type: string PersonType: enum: - Undefined - NaturalPerson - LegalEntity - Company - Customer type: string PrintType: enum: - None - NFeNormalPortrait - NFeNormalLandscape - NFeSimplified - DANFE_NFC_E - DANFE_NFC_E_MSG_ELETRONICA type: string ProductInvoiceEventsResource: type: object properties: events: type: array items: $ref: '#/components/schemas/ActivityResource' description: Lista de Eventos ocorridos na Nota Fiscal nullable: true hasMore: type: boolean description: Identificador de possibilidade de mais itens. nullable: true id: type: string description: Identificação nullable: true accountId: type: string description: Identificador da Conta nullable: true companyId: type: string description: Identificador da Empresa nullable: true additionalProperties: false ProductInvoiceQueueIssueResource: type: object properties: id: type: string description: Identificador único nullable: true payment: type: array items: $ref: '#/components/schemas/PaymentResource' description: Grupo de Formas de Pagamento (pag) nullable: true serie: type: integer description: Série do Documento Fiscal (serie) format: int32 nullable: true number: type: integer description: Número do Documento Fiscal (nNF) format: int64 nullable: true operationOn: type: string description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" format: date-time nullable: true operationNature: type: string description: Descrição da Natureza da Operação (natOp) nullable: true operationType: $ref: '#/components/schemas/OperationType' destination: $ref: '#/components/schemas/Destination' printType: $ref: '#/components/schemas/PrintType' purposeType: $ref: '#/components/schemas/PurposeType' consumerType: $ref: '#/components/schemas/ConsumerType' presenceType: $ref: '#/components/schemas/ConsumerPresenceType' contingencyOn: type: string description: "Data e Hora da entrada em contingência (dhCont)\r\n\r\n Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD\r\n" format: date-time nullable: true contingencyJustification: type: string description: Justificativa da entrada em contingência (xJust) nullable: true buyer: $ref: '#/components/schemas/BuyerResource' transport: $ref: '#/components/schemas/TransportInformationResource' additionalInformation: $ref: '#/components/schemas/AdditionalInformationResource' export: $ref: '#/components/schemas/ExportResource' items: type: array items: $ref: '#/components/schemas/InvoiceItemResource' description: Detalhamento de Produtos e Serviços (det) nullable: true billing: $ref: '#/components/schemas/BillingResource' issuer: $ref: '#/components/schemas/IssuerFromRequestResource' transactionIntermediate: $ref: '#/components/schemas/IntermediateResource' delivery: $ref: '#/components/schemas/DeliveryInformationResource' withdrawal: $ref: '#/components/schemas/WithdrawalInformationResource' totals: $ref: '#/components/schemas/Total' additionalProperties: false description: Notas Fiscais Eletrônicas (NFe) ProductInvoicesResource: type: object properties: productInvoices: type: array items: $ref: '#/components/schemas/InvoiceWithoutEventsResource' description: Lista de Notas Fiscais Eletrônicas (NF-e) nullable: true hasMore: type: boolean description: Identificador de possibilidade de mais itens. additionalProperties: false description: Notas Fiscais Eletrônicas (NF-e) PumpResource: type: object properties: spoutNumber: type: integer description: Número de identificação do bico utilizado no abastecimento (nBico) format: int32 nullable: true number: type: integer description: Número de identificação da bomba ao qual o bico está interligado (nBomba) format: int32 nullable: true tankNumber: type: integer description: Número de identificação do tanque ao qual o bico está interligado (nTanque) format: int32 nullable: true beginningAmount: type: number description: Valor do Encerrante no início do abastecimento (vEncIni) format: double nullable: true endAmount: type: number description: Valor do Encerrante no final do abastecimento (vEncFin) format: double nullable: true percentageBio: type: number description: Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador format: double nullable: true additionalProperties: false PurposeType: enum: - None - Normal - Complement - Adjustment - Devolution type: string QueueEventResource: type: object properties: reason: type: string description: "Justificativa da carta de correção\r\nO Texto deve conter no mínimo 15 e no máximo 1.000 caracteres\r\n(os quais não poderão conter acentos e/ou caracteres especiais)" nullable: true additionalProperties: false ReboqueResource: type: object properties: plate: type: string description: Placa do Veiculo (placa) nullable: true uf: type: string description: UF Veiculo Reboque (UF) nullable: true rntc: type: string description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) nullable: true wagon: type: string description: Identificação do Vagão (vagao) nullable: true ferry: type: string description: Identificação da Balsa (balsa) nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Reboque" ReceiverStateTaxIndicator: enum: - None - TaxPayer - Exempt - NonTaxPayer type: string ReferencedProcessResource: type: object properties: identifierConcessory: type: string nullable: true identifierOrigin: type: integer format: int32 nullable: true concessionActType: type: integer format: int32 nullable: true additionalProperties: false RequestCancellationResource: type: object properties: accountId: type: string nullable: true companyId: type: string nullable: true productInvoiceId: type: string nullable: true reason: type: string nullable: true additionalProperties: false ShippingModality: enum: - ByIssuer - ByReceiver - ByThirdParties - OwnBySender - OwnByBuyer - Free type: string SpecialTaxRegime: enum: - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte - Automatico type: string description: Regime especial de tributação StateCode: enum: - NA - RO - AC - AM - RR - PA - AP - TO - MA - PI - CE - RN - PB - PE - AL - SE - BA - MG - ES - RJ - SP - PR - SC - RS - MS - MT - GO - DF - EX type: string StateTaxProcessingAuthorizer: enum: - Normal - EPEC type: string TaxCouponInformationResource: type: object properties: modelDocumentFiscal: type: string description: Modelo de Documento Fiscal (mod) nullable: true orderECF: type: string description: Número de Ordem Sequencial do ECF (nECF) nullable: true orderCountOperation: type: integer description: Número do Contador de Ordem de Operação (nCOO) format: int32 nullable: true additionalProperties: false TaxDeterminationResource: type: object properties: operationCode: type: integer description: Código interno para determinação de natureza de operação format: int32 nullable: true issuerTaxProfile: type: string description: Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos nullable: true buyerTaxProfile: type: string description: Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos nullable: true origin: type: string description: Origem da mercadoria nullable: true acquisitionPurpose: type: string description: Finalidade de aquisição - usado para o cálculo automático de impostos nullable: true additionalProperties: false TaxDocumentsReferenceResource: type: object properties: taxCouponInformation: $ref: '#/components/schemas/TaxCouponInformationResource' documentInvoiceReference: $ref: '#/components/schemas/DocumentInvoiceReferenceResource' documentElectronicInvoice: $ref: '#/components/schemas/DocumentElectronicInvoiceResource' additionalProperties: false TaxRegime: enum: - None - LucroReal - LucroPresumido - SimplesNacional - SimplesNacionalExcessoSublimite - MicroempreendedorIndividual - Isento type: string description: Regime de tributação TaxpayerCommentsResource: type: object properties: field: type: string description: Campo (xCampo) nullable: true text: type: string description: Texto (xTexto) nullable: true additionalProperties: false Total: type: object properties: icms: $ref: '#/components/schemas/ICMSTotal' issqn: $ref: '#/components/schemas/ISSQNTotal' additionalProperties: false TotalResource: type: object properties: icms: $ref: '#/components/schemas/ICMSTotalResource' issqn: $ref: '#/components/schemas/ISSQNTotalResource' additionalProperties: false TransportGroupResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true id: type: string description: Identificação nullable: true name: type: string description: Nome ou Razão Social (xNome) nullable: true federalTaxNumber: type: integer description: CNPJ ou CPF format: int64 nullable: true email: type: string description: Email nullable: true address: $ref: '#/components/schemas/AddressResource' type: $ref: '#/components/schemas/PersonType' stateTaxNumber: type: string description: Inscrição Estadual do Transportador (IE) nullable: true transportRetention: type: string description: Grupo de Retenção do ICMS do transporte nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Transportador" TransportInformationResource: type: object properties: freightModality: $ref: '#/components/schemas/ShippingModality' transportGroup: $ref: '#/components/schemas/TransportGroupResource' reboque: $ref: '#/components/schemas/ReboqueResource' volume: $ref: '#/components/schemas/VolumeResource' transportVehicle: $ref: '#/components/schemas/TransportVehicleResource' sealNumber: type: string description: Número dos Lacres nullable: true transpRate: $ref: '#/components/schemas/TransportRateResource' additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de Informações do Transporte da NF-e\r\nId: X01 Pai: A1" TransportRateResource: type: object properties: serviceAmount: type: number description: Valor do Serviço (vServ) format: double nullable: true bcRetentionAmount: type: number description: BC da Retenção do ICMS (vBCRet) format: double nullable: true icmsRetentionRate: type: number description: Alíquota da Retenção (pICMSRet) //Change to Rate format: double nullable: true icmsRetentionAmount: type: number description: Valor do ICMS Retido (vICMSRet) format: double nullable: true cfop: type: integer description: CFOP de Serviço de Transporte (CFOP) format: int64 nullable: true cityGeneratorFactCode: type: integer description: Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) format: int64 nullable: true additionalProperties: false TransportVehicleResource: type: object properties: plate: type: string description: Placa do Veiculo (placa) nullable: true state: type: string description: Sigla da UF (UF) nullable: true rntc: type: string description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Veiculo" VolumeResource: type: object properties: volumeQuantity: type: integer description: Quantidade de volumes transportados (qVol) format: int32 nullable: true species: type: string description: Espécie dos volumes transportados (esp) nullable: true brand: type: string description: Marca dos Volumes Transportados (marca) nullable: true volumeNumeration: type: string description: Numeração dos Volumes Transportados (nVol) nullable: true netWeight: type: number description: Peso Liquido(em Kg) (pesoL) format: double nullable: true grossWeight: type: number description: Peso Bruto(em Kg) (pesoB) format: double nullable: true additionalProperties: false description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nVolumes\r\nId:X26" WithdrawalInformationResource: type: object properties: accountId: type: string description: Identificador da Conta nullable: true id: type: string description: Identificação nullable: true name: type: string description: Nome ou Razão Social (xNome) nullable: true federalTaxNumber: type: integer description: CNPJ ou CPF format: int64 nullable: true email: type: string description: Email nullable: true address: $ref: '#/components/schemas/AddressResource' type: $ref: '#/components/schemas/PersonType' stateTaxNumber: type: string description: Inscrição Estadual (IE) nullable: true additionalProperties: false description: Identificação do Local de retirada (retirada) securitySchemes: Authorization_Header: type: apiKey description: Autenticar usando o cabeçalho HTTP name: Authorization in: header Authorization_QueryParam: type: apiKey description: Autenticar usando o parâmetro na URL name: apikey in: query Authorization_JwtBearer: type: http description: Autenticar usando o cabeçalho HTTP scheme: bearer bearerFormat: Json Web Token security: - Authorization_Header: [] Authorization_QueryParam: [] - Authorization_JwtBearer: [] x-original-swagger-version: "2.0"