openapi: 3.0.0 servers: - url: https://api.nfe.io description: Nota Fiscal de Serviço - url: https://api.nfse.io description: Webhooks info: title: Nota Fiscal de Serviço version: v1 description: "# Introdução\nSeja bem-vindo a documentação da API de Nota Fiscal de Serviço!\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# Como usar a API?\nLogo a seguir você encontrará todos os recursos e métodos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\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 topo desta página para que os métodos funcionem corretamente.\nNo seu código e 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" tags: - name: Companies description: | :::warning Grupo em descontinuação Os endpoints deste grupo (`api.nfe.io/v1/companies/*`) fazem parte da **API legada de Nota Fiscal de Serviço v1** e estão em processo de descontinuação. A partir de agora, o gerenciamento de empresas é feito pela [**API de Contribuintes v2**](/docs/desenvolvedores/rest-api/contribuintes-v2), com a combinação de dois recursos: - **Empresa** ([API de Empresas v2](/docs/documentacao/gerenciamento-empresas/api-empresas)) - **Inscrição Municipal** ([API de Inscrições Municipais v2](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais)) — necessária para emissão de NFS-e ::: ## Equivalência v1 → v2 | Endpoint v1 (descontinuado) | Endpoint v2 equivalente | |---|---| | `GET /v1/companies` — Listar empresas | [Consultar todas as Empresas da Conta](/docs/desenvolvedores/rest-api/contribuintes-v2/consultar-todas-as-empresas-da-conta) | | `POST /v1/companies` — Criar empresa | [Criar uma Empresa](/docs/desenvolvedores/rest-api/contribuintes-v2/criar-uma-empresa) | | `GET /v1/companies/{id}` — Consultar empresa | [Consultar uma Empresa pelo ID](/docs/desenvolvedores/rest-api/contribuintes-v2/consultar-uma-empresa-pelo-id) | | `PUT /v1/companies/{id}` — Atualizar empresa | [Alterar uma Empresa pelo ID](/docs/desenvolvedores/rest-api/contribuintes-v2/alterar-uma-empresa-pelo-id) | | `DELETE /v1/companies/{id}` — Excluir empresa | [Excluir uma Empresa por ID](/docs/desenvolvedores/rest-api/contribuintes-v2/excluir-uma-empresa-por-id) | | `POST /v1/companies/{id}/certificate` — Upload de certificado | [Upload de um Certificado](/docs/desenvolvedores/rest-api/contribuintes-v2/upload-de-um-certificado) | > **Importante:** Para emitir NFS-e na nova API é preciso, além de criar a empresa, **vincular uma Inscrição Municipal**. Veja a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e o [guia de migração na release-note 2026.1](/docs/release-notes/2026-1-unificacao-api-contribuintes). paths: /v1/companies: get: tags: - Companies summary: Listar as empresas ativas de uma conta description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_Get parameters: - name: pageCount in: query description: Items por página required: false schema: type: integer format: int32 - name: pageIndex in: query description: Número da página required: false schema: type: integer format: int32 responses: "200": description: Consulta realizada com sucesso content: application/json: schema: type: object properties: companies: type: array items: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] post: tags: - Companies summary: Criar uma empresa description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_Post requestBody: description: Dados da empresa required: true content: application/json: schema: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string responses: "201": description: Sucesso na criação da empresa content: application/json: schema: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "409": description: Já existe uma empresa com o CNPJ informado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id_or_tax_number}: get: tags: - Companies summary: Obter os detalhes de uma empresa description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_idGet parameters: - name: company_id_or_tax_number in: path description: ID da empresa ou Inscrição Federal (CNPJ) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}: put: tags: - Companies summary: Atualizar uma empresa description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_Put requestBody: description: Dados da empresa required: true content: application/json: schema: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string responses: "200": description: Sucesso na atualização da empresa content: application/json: schema: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - Companies summary: Excluir uma empresa description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na remoção da empresa content: application/json: schema: type: object "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: empresa não foi encontrada content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/certificate: post: tags: - Companies summary: Upload do certificado digital da empresa usando o codificação multipart/form-data. description: | :::warning Endpoint em descontinuação Este endpoint faz parte da API legada (`api.nfe.io/v1/companies`) e **está em processo de descontinuação**. A nova forma de gerenciar empresas combina **dois recursos** da API de Contribuintes v2: - **Empresa** — [API de Empresas (v2)](/docs/documentacao/gerenciamento-empresas/api-empresas) - **Inscrição Municipal** — [API de Inscrições Municipais (v2)](/docs/documentacao/gerenciamento-empresas/api-inscricoes-municipais) Consulte a [Visão Geral do Gerenciamento de Empresas](/docs/documentacao/gerenciamento-empresas/visao-geral) e a [release-note 2026.1 — Unificação da API de Contribuintes](/docs/release-notes/2026-1-unificacao-api-contribuintes) para o guia de migração completo. ::: operationId: Companies_CertificateUpload requestBody: description: Arquivo do certificado digital com extensao PFX ou P12 required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary password: type: string responses: "200": description: Sucesso na atualização da certificado digital content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Empresa não foi encontrada content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "415": description: Nenhum arquivo foi encontrado na requisição content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications: get: tags: - ServiceInvoiceNotifications summary: Listar as notificações de uma empresa description: Utilize esta requisição para consultar uma lista das **Notificações** cadastradas na **Empresa**. operationId: ServiceInvoiceNotifications_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Consulta realizada com sucesso content: application/json: schema: type: object properties: notifications: type: array items: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications/{notification_id}: get: tags: - ServiceInvoiceNotifications summary: Consultar uma notificação existente description: Utilize esta requisição para consultar uma **Notificação** que esteja cadastrada e tenha o ID igual ao parametro **{notification_id}**. operationId: ServiceInvoiceNotifications_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: notification_id in: path description: ID da notificação a ser consultado required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: notification: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - ServiceInvoiceNotifications summary: Excluir uma notificação operationId: ServiceInvoiceNotifications_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: notification_id in: path description: ID da notificação required: true schema: type: string responses: "200": description: Sucesso na remoção da empresa content: application/json: schema: type: object "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: empresa não foi encontrada content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications/email: post: tags: - ServiceInvoiceNotifications summary: Criar notificação via Email da Nota Fiscal de Serviço (NFSE) description: "Utilize esta requisição para definir se os Tomadores (Clientes) das Notas Fiscais de Serviço (NFSE)\r\ndevem ser notificados via email que a NFSE foi **emitida** ou **cancelada** com sucesso." operationId: ServiceInvoiceNotifications_Post parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string requestBody: description: Dados da notificação required: true content: application/json: schema: description: Cria Notificação para Email type: object properties: filters: description: "Lista de filtros de evento sem distinção entre maiúsculas e minúsculas associado a esta notificação.\r\nOs filtros de evento são usados para determinar em quais eventos essa notificação será acionada.\r\nOs valores de filtros suportados pode ser consultados através do requisição na API de **Tipos de Eventos**." type: array items: type: string status: description: "Determina se as notificações são enviadas quando o evento é gerado.\r\nDefinir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active**\r\npara receber todas as notificações." enum: - Active - Inactive type: string responses: "201": description: Sucesso na criação da empresa content: application/json: schema: type: object properties: notification: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "409": description: Já existe uma empresa com o CNPJ informado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/eventTypes: get: tags: - EventTypes summary: Listar os Tipos de Eventos gerados pela plataforma description: "Eventos 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 do nome do evento.\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." operationId: EventTypes_GetAll responses: "200": description: Sucesso na consulta do tipos de eventos content: application/json: schema: description: Tipos de Eventos type: object properties: eventTypes: description: Lista de Evento type: array items: description: "Eventos 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." type: object properties: id: 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**" type: string description: description: Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. type: string "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/legalpeople: get: tags: - LegalPeople summary: Listar as pessoas jurídicas ativas operationId: LegalPeople_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/legalpeople/{id}: get: tags: - LegalPeople summary: Obter os detalhes de uma pessoa jurídica operationId: LegalPeople_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da pessoa juridica required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: legalPeople: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/naturalpeople: get: tags: - NaturalPeople summary: Listar as pessoas físicas ativas operationId: NaturalPeople_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: naturalPeople: type: array items: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome completo type: string federalTaxNumber: format: int64 description: CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string birthDate: format: date-time description: Data nascimento type: string idNumber: description: Número do Registro Geral (RG) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/naturalpeople/{id}: get: tags: - NaturalPeople summary: Obter os detalhes de uma pessoa física operationId: NaturalPeople_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da pessoa física required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome completo type: string federalTaxNumber: format: int64 description: CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string birthDate: format: date-time description: Data nascimento type: string idNumber: description: Número do Registro Geral (RG) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices: get: tags: - ServiceInvoices summary: Listar as Notas Fiscais de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: pageCount in: query description: Items por página required: false schema: type: integer format: int32 - name: pageIndex in: query description: Número da página required: false schema: type: integer format: int32 - name: issuedBegin in: query description: Data de competência início required: false schema: type: string format: yyyy-MM-dd - name: issuedEnd in: query description: Data de competência fim required: false schema: type: string format: yyyy-MM-dd - name: createdBegin in: query description: Data de criação início required: false schema: type: string format: yyyy-MM-dd - name: createdEnd in: query description: Data de criação fim required: false schema: type: string format: yyyy-MM-dd - name: hasTotals in: query required: false schema: type: boolean responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: serviceInvoices: type: array items: required: - environment type: object properties: id: description: Identificação type: string environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string flowStatus: description: | Status do processamento da NFS-e no fluxo de emissão. Valores possíveis: - `CancelFailed` (-2): Falha no cancelamento — tentativa de cancelar a NFS-e foi rejeitada - `IssueFailed` (-1): Falha na emissão — a NFS-e não foi autorizada pela Prefeitura - `Issued` (1): Emitida — autorizada pela Prefeitura - `Cancelled` (2): Cancelada - `PullFromCityHall` (3): Capturada da Prefeitura (sincronização de NFS-e já emitida fora da plataforma) - `WaitingCalculateTaxes` (10): Aguardando cálculo de tributos - `WaitingDefineRpsNumber` (11): Aguardando definição do número da RPS - `WaitingSend` (12): Aguardando envio à Prefeitura - `WaitingSendCancel` (13): Aguardando envio do cancelamento à Prefeitura - `WaitingReturn` (14): Aguardando retorno da Prefeitura - `WaitingDownload` (15): Aguardando download do XML/PDF enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: | Tipo da tributação do ISSQN (TributacaoRPS). Valores possíveis: - `None`: Nenhuma - `WithinCity`: Tributação dentro do mesmo município - `OutsideCity`: Tributação fora do município - `Export`: Exportação - `Free`: Isento - `Immune`: Imune - `SuspendedCourtDecision`: Exigibilidade suspensa por decisão judicial - `SuspendedAdministrativeProcedure`: Exigibilidade suspensa por procedimento administrativo - `OutsideCityFree`: Tributação fora do município porém isento - `OutsideCityImmune`: Tributação fora do município porém imune - `OutsideCitySuspended`: Tributação fora do município porém suspensa - `OutsideCitySuspendedAdministrativeProcedure`: Tributação fora do município, suspensa por procedimento administrativo - `ObjectiveImune`: Tributação no município com indicação de imunidade objetiva enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number paidAmount: format: double description: Valor dos Serviços pago type: number paymentMethod: description: Formas de pagamento enum: - None - Cash - Check - CreditCard - DebitCard - StoreCredit - FoodVoucher - MealVoucher - GiftCard - FuelVoucher - Others type: string deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] post: tags: - ServiceInvoices summary: Emitir uma Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Post parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string requestBody: description: Dados da nota fiscal de serviço required: true content: application/json: schema: description: Emissão de nota fiscal de serviço required: - cityServiceCode - description - servicesAmount type: object properties: borrower: description: | Tomador dos serviços. **Opcional**: o grupo `borrower` pode ser omitido. Quando informado, aplicam-se validações condicionais aos seus campos: - `name`: se informado, no máximo 115 caracteres; - `federalTaxNumber`: se informado (diferente de zero), deve ser um CNPJ/CPF válido e coerente com o `type` (`NaturalPerson` → CPF; `LegalEntity` → CNPJ). Para tomador no exterior (`address.country` ≠ `BRA`), não é validado; - `phoneNumber`: se informado, entre 7 e 20 dígitos; - `address`: opcional, mas se um endereço **brasileiro** for parcialmente preenchido, passam a ser obrigatórios `postalCode`, `street`, `city.code` (código IBGE de 7 dígitos), `city.name` e `state` (UF de 2 letras), que devem ser consistentes entre si. required: [] type: object properties: type: description: | Tipo do tomador dos serviços. Valores possíveis: - `Undefined`: Indefinido - `NaturalPerson`: Pessoa Física (CPF) - `LegalEntity`: Pessoa Jurídica (CNPJ) enum: - Undefined - NaturalPerson - LegalEntity type: string name: description: Nome / Razão Social type: string maxLenght: 115 federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer maxLength: 14 municipalTaxNumber: description: Inscrição Municipal para Pessoas Jurídicas type: string maxLength: 12 stateTaxNumber: description: Inscrição Estadual (opcional, não se aplica a todos) type: string maxLength: 19 taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string caepf: description: Cadastro de Atividade Econômica da Pessoa Física (CAEPF) type: string maxLength: 14 phoneNumber: description: Telefone type: string minLength: 7 maxLenght: 20 email: description: Email type: string noTaxIdReason: description: | Justificativa para ausência de NIF (Número de Identificação Fiscal). Valores possíveis: - `NotInformedOriginal`: Não informado na nota de origem - `Exempted`: Dispensado do NIF - `NotRequired`: Não exigência do NIF enum: - NotInformedOriginal - Exempted - NotRequired type: string address: description: Endereço required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string length: 3 postalCode: description: 'CEP (Exemplo: 99999-999)' type: string length: 9 street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string length: 7 name: description: Nome type: string state: description: Estado type: string length: 2 externalId: description: Identificação única do cliente type: string cityServiceCode: description: Código do serviço no municipio type: string federalServiceCode: description: Código federal do servico (Item da lista de serviço LC 116) type: string cnaeCode: description: Código CNAE (somente quando necessario na cidade) type: string nbsCode: description: Código do NBS no municipio (somente quando necessario na cidade) type: string description: description: Descrição dos serviços type: string servicesAmount: format: double description: Valor do serviços type: number rpsSerialNumber: description: Número de Serie da RPS type: string issuedOn: format: date-time description: Data da emissão no formato YYYY-MM-DDTHH:MM:SS.SSSSSS-03:00 type: string rpsNumber: format: int64 description: Número da RPS type: integer taxationType: description: | Tipo da tributação do ISSQN (TributacaoRPS). Valores possíveis: - `None`: Nenhuma - `WithinCity`: Tributação dentro do mesmo município - `OutsideCity`: Tributação fora do município - `Export`: Exportação - `Free`: Isento - `Immune`: Imune - `SuspendedCourtDecision`: Exigibilidade suspensa por decisão judicial - `SuspendedAdministrativeProcedure`: Exigibilidade suspensa por procedimento administrativo - `OutsideCityFree`: Tributação fora do município porém isento - `OutsideCityImmune`: Tributação fora do município porém imune - `OutsideCitySuspended`: Tributação fora do município porém suspensa - `OutsideCitySuspendedAdministrativeProcedure`: Tributação fora do município, suspensa por procedimento administrativo - `ObjectiveImune`: Tributação no município com indicação de imunidade objetiva enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string ncmCode: description: Código NCM (Nomenclatura Comum do Mercosul) (NCM) type: string maxLength: 8 paidAmount: format: double description: Valor dos Serviços pago (Valor Total Recebido) type: number accrualOn: format: date description: Data da competência da prestação do serviço no formato AAAA-MM-DD (Competencia). Se não for informado, o sistema utilizará a data do campo `issuedOn`. type: string cstPisCofins: description: | Código de Situação Tributária do PIS/COFINS (CST). Valores: - `00`: Nenhum - `01`: Operação Tributável com Alíquota Básica - `02`: Operação Tributável com Alíquota Diferenciada - `03`: Operação Tributável com Alíquota por Unidade de Medida de Produto - `04`: Operação Tributável monofásica - Revenda a Alíquota Zero - `05`: Operação Tributável por Substituição Tributária - `06`: Operação Tributável a Alíquota Zero - `07`: Operação Tributável da Contribuição - `08`: Operação sem Incidência da Contribuição - `09`: Operação com Suspensão da Contribuição enum: ["00", "01", "02", "03", "04", "05", "06", "07", "08", "09"] type: string pisCofinsBaseTax: format: double description: Base de cálculo para o PIS e COFINS (vBCPisCofins) type: number pisRate: format: double description: Alíquota do PIS (pAliqPis). Se não for informado, o sistema utilizará o valor definido no cadastro do código de serviço. type: number pisAmount: format: double description: Valor do PIS (vPis). Campo utilizado para informar o valor do PIS, porém sem retenção. type: number cofinsRate: format: double description: Alíquota do COFINS (pAliqCofins). Se não for informado, o sistema utilizará o valor definido no cadastro do código de serviço. type: number cofinsAmount: format: double description: Valor do COFINS (vCofins). Campo utilizado para informar o valor do COFINS, porém sem retenção. type: number csllAmount: format: double description: Valor do CSLL (vCSLL). Campo utilizado para informar o valor do CSLL, porém sem retenção. type: number csllRate: format: double description: Alíquota do CSLL (pAliqCSLL) type: number inssRate: format: double description: Alíquota do INSS type: number ipiRate: format: double description: SP - Alíquota IPI (pAliqIPI). Se não for informado, o sistema utilizará o valor definido no cadastro do código de serviço. type: number ipiAmount: format: double description: SP - Valor IPI (vIPI). Se não for informado, o sistema realizará o cálculo automático. type: number immunityType: description: | Tipo de imunidade (tpImunidade) — usar apenas quando `taxationType = Immune`. Valores possíveis: - `Unspecified`: Imunidade (tipo não informado na nota de origem) - `PublicEntitiesMutual`: Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a) - `Temples`: Templos de qualquer culto (CF88, Art 150, VI, b) - `PartiesUnionsEducationSocialNonprofit`: Patrimônio, renda ou serviços dos partidos políticos, inclusive suas fundações, das entidades sindicais dos trabalhadores, das instituições de educação e de assistência social, sem fins lucrativos (CF88, Art 150, VI, c) - `BooksPressPaper`: Livros, jornais, periódicos e o papel destinado a sua impressão (CF88, Art 150, VI, d) - `BrazilianMusicPhonograms`: Fonogramas e videofonogramas musicais produzidos no Brasil (CF88, Art 150, VI, e) enum: [Unspecified, PublicEntitiesMutual, Temples, PartiesUnionsEducationSocialNonprofit, BooksPressPaper, BrazilianMusicPhonograms] type: string retentionType: description: | Tipo de retenção do ISSQN (tpRetISSQN). Define quem é o responsável pelo recolhimento do ISSQN. Se um valor for enviado na integração, ele será utilizado; caso contrário, o sistema aplicará a regra de cálculo automática. Valores possíveis: - `NotWithheld`: Não Retido — o prestador é o responsável pelo recolhimento. - `WithheldByBuyer`: Retido pelo Tomador — a responsabilidade pelo recolhimento é transferida para o tomador. - `WithheldByIntermediary`: Retido pelo Intermediário — a responsabilidade pelo recolhimento é transferida para o intermediário. enum: [NotWithheld, WithheldByBuyer, WithheldByIntermediary] default: NotWithheld type: string isEarlyInstallmentPayment: description: Indica se é uma nota fiscal de pagamento parcelado antecipado, realizado antes do fornecimento do serviço. type: boolean intermediary: description: | Grupo de informações relativas ao intermediário do serviço (interm). Possui a mesma estrutura do `borrower`. **Opcional**: envie apenas quando houver intermediário na operação (por exemplo, quando a retenção do ISS é feita pelo intermediário). Quando informado, os campos básicos de identificação são `type`, `federalTaxNumber` (CNPJ/CPF/NIF) e `name`. type: object properties: type: description: | Tipo do intermediário. Valores possíveis: - `Undefined`: Indefinido - `NaturalPerson`: Pessoa Física (CPF) - `LegalEntity`: Pessoa Jurídica (CNPJ) enum: [Undefined, NaturalPerson, LegalEntity] type: string name: description: Nome / Razão Social type: string maxLength: 115 federalTaxNumber: format: int64 description: CNPJ, CPF ou NIF (Número de Identificação Fiscal) type: integer municipalTaxNumber: description: Inscrição Municipal type: string maxLength: 12 stateTaxNumber: description: Inscrição Estadual (Opcional) type: string maxLength: 19 taxRegime: description: Tipo do Regime Tributário enum: [Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal] type: string caepf: description: Cadastro de Atividade Econômica da Pessoa Física (CAEPF) type: string maxLength: 14 phoneNumber: description: Telefone type: string email: description: Email type: string noTaxIdReason: description: | Justificativa para ausência de NIF. Valores possíveis: - `NotInformedOriginal`: Não informado na nota de origem - `Exempted`: Dispensado do NIF - `NotRequired`: Não exigência do NIF enum: [NotInformedOriginal, Exempted, NotRequired] type: string address: description: Endereço type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF type: string recipient: description: | Destinatário final do serviço, quando diferente do tomador. Possui a mesma estrutura do `borrower`. type: object properties: type: description: | Tipo do destinatário. Valores possíveis: - `Undefined`: Indefinido - `NaturalPerson`: Pessoa Física (CPF) - `LegalEntity`: Pessoa Jurídica (CNPJ) enum: [Undefined, NaturalPerson, LegalEntity] type: string name: description: Nome / Razão Social type: string maxLength: 115 federalTaxNumber: format: int64 description: CNPJ, CPF ou NIF (Número de Identificação Fiscal) type: integer municipalTaxNumber: description: Inscrição Municipal type: string maxLength: 12 stateTaxNumber: description: Inscrição Estadual (Opcional) type: string maxLength: 19 taxRegime: description: Tipo do Regime Tributário enum: [Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal] type: string caepf: description: Cadastro de Atividade Econômica da Pessoa Física (CAEPF) type: string maxLength: 14 phoneNumber: description: Telefone type: string email: description: Email type: string noTaxIdReason: description: | Justificativa para ausência de NIF. Valores possíveis: - `NotInformedOriginal`: Não informado na nota de origem - `Exempted`: Dispensado do NIF - `NotRequired`: Não exigência do NIF enum: [NotInformedOriginal, Exempted, NotRequired] type: string address: description: Endereço type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF type: string referenceSubstitution: description: Grupo de informações relativas à NFS-e a ser substituída (chSubstda). type: object properties: id: description: Identificador da NFS-e a ser substituída (chave de 44 dígitos). type: string pattern: '^[0-9]{44}$' reason: description: | Motivo da substituição (cMotivo). Valores possíveis: - `SnOut`: Desenquadramento de NFS-e do Simples Nacional - `SnIn`: Enquadramento de NFS-e no Simples Nacional - `ImmunityAddRetro`: Inclusão Retroativa de Imunidade/Isenção para NFS-e - `ImmunityRemoveRetro`: Exclusão Retroativa de Imunidade/Isenção para NFS-e - `RejectionBuyerOrIntermediary`: Rejeição da NFS-e pelo tomador ou intermediário responsável pelo recolhimento - `Other`: Outros enum: [SnOut, SnIn, ImmunityAddRetro, ImmunityRemoveRetro, RejectionBuyerOrIntermediary, Other] type: string reasonText: description: Descrição do motivo (xMotivo). Obrigatório quando `reason = Other`. type: string maxLength: 500 lease: description: Grupo de informações relativas a atividades de Locação, sublocação, arrendamento, direito de passagem ou permissão de uso, compartilhado ou não, de ferrovia, rodovia, postes, cabos, dutos e condutos de qualquer natureza. type: object properties: category: description: | Categoria do serviço. Valores possíveis: - `Lease`: Locação - `Sublease`: Sublocação - `Leasehold`: Arrendamento - `RightOfWay`: Direito de passagem - `UsePermission`: Permissão de uso enum: [Lease, Sublease, Leasehold, RightOfWay, UsePermission] type: string objectType: description: | Objeto da locação/sublocação/arrendamento/etc. Valores possíveis: - `Railway`: Ferrovia - `Road`: Rodovia - `Poles`: Postes - `Cables`: Cabos - `Pipelines`: Dutos - `Conduits`: Condutos enum: [Railway, Road, Poles, Cables, Pipelines, Conduits] type: string totalLength: format: double description: Comprimento total de ferrovia/rodovia/cabos/dutos/condutos (extensao). type: number polesCount: format: int32 description: Número total de postes (nPostes). type: integer minimum: 0 construction: description: Grupo de informações relativas a obras de construção civil e congêneres. Apenas uma das opções (`workId`, `cibCode` ou `siteAddress`) deve ser preenchida. type: object properties: propertyFiscalRegistration: description: 'Inscrição imobiliária fiscal (inscImobFisc), exemplos: SQL ou INCRA.' type: string maxLength: 60 workId: description: Identificação da obra (CNO/CEI) — cObra. type: object properties: scheme: description: | Tipo de cadastro da obra. Valores possíveis: - `bra.cno`: Cadastro Nacional de Obras - `bra.cei`: Cadastro Específico do INSS enum: [bra.cno, bra.cei] type: string value: description: Número da obra no cadastro selecionado. type: string maxLength: 30 cibCode: description: Código do Cadastro Imobiliário Brasileiro (cCIB). type: string maxLength: 30 siteAddress: description: Endereço da obra (nacional ou exterior). type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999) ou Código de Endereçamento Postal no exterior' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF (ou Estado, Província, Região no exterior) type: string encapsulationNumber: description: | Número do encapsulamento da obra (NumeroEncapsulamento). String numérica com 1 a 12 dígitos. Atualmente utilizado apenas pelo serializador do município de São Paulo (Paulistana). Zeros à esquerda são preservados. type: string minLength: 1 maxLength: 12 pattern: '^[0-9]{1,12}$' realEstate: description: Grupo de informações de operações relacionadas a bens imóveis, exceto obras. Apenas uma das opções (`cibCode` ou `siteAddress`) deve ser preenchida. type: object properties: propertyFiscalRegistration: description: Inscrição imobiliária fiscal (inscImobFisc). type: string maxLength: 60 cibCode: description: Código do Cadastro Imobiliário Brasileiro (cCIB). type: string maxLength: 30 siteAddress: description: Endereço do imóvel (nacional ou exterior). type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999) ou Código de Endereçamento Postal no exterior' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF (ou Estado, Província, Região no exterior) type: string foreignTrade: description: Grupo de informações sobre transações entre residentes ou domiciliados no Brasil com residentes ou domiciliados no exterior. type: object properties: serviceMode: description: | Modo de prestação (mdPrestacao). Valores possíveis: - `Unknown`: Desconhecido - `CrossBorder`: Transfronteiriço - `ConsumptionInBrazil`: Consumo no Brasil - `TemporaryPersonnel`: Movimento Temporário de Pessoas Físicas - `ConsumptionAbroad`: Consumo no Exterior enum: [Unknown, CrossBorder, ConsumptionInBrazil, TemporaryPersonnel, ConsumptionAbroad] type: string relationShip: description: | Vínculo entre as partes (vincPrest). Valores possíveis: - `NoLink`: Sem vínculo com o Tomador/Prestador - `Controlled`: Controlada - `Controller`: Controladora - `Affiliate`: Coligada - `HeadOffice`: Matriz - `Branch`: Filial ou sucursal - `OtherLink`: Outro vínculo enum: [NoLink, Controlled, Controller, Affiliate, HeadOffice, Branch, OtherLink] type: string currency: description: Moeda da transação (tabela de moedas do Banco Central do Brasil). type: string pattern: '^[0-9]+$' serviceAmountInCurrency: format: double description: Valor do serviço na moeda informada em `currency`. type: number supportMechanismProvider: description: | Mecanismo de apoio/fomento utilizado pelo prestador (mecAFComexP). Valores possíveis: - `Unknown`: Desconhecido - `None`: Nenhum - `Acc`: ACC - Adiantamento sobre Contrato de Câmbio - `Ace`: ACE - Adiantamento sobre Cambiais Entregues - `BndesEximPostShipServices`: BNDES-Exim Pós-Embarque - Serviços - `BndesEximPreShipServices`: BNDES-Exim Pré-Embarque - Serviços - `Fge`: FGE - Fundo de Garantia à Exportação - `ProexEqualization`: PROEX - Equalização - `ProexFinancing`: PROEX - Financiamento type: string enum: [Unknown, None, Acc, Ace, BndesEximPostShipServices, BndesEximPreShipServices, Fge, ProexEqualization, ProexFinancing] supportMechanismReceiver: description: | Mecanismo de apoio/fomento utilizado pelo tomador (mecAFComexT). Valores possíveis: - `Unknown`: Desconhecido - `None`: Nenhum - `PublicAdminAndInternationalRep`: Adm. Pública e Representação Internacional - `LeasesMachineryShipsAircraft`: Aluguéis e Arrend. Mercantil de máquinas, equipamentos, embarcações e aeronaves - `AircraftLeaseAirTransportPublic`: Arrendamento Mercantil de aeronave para empresa de transporte aéreo público - `ExportAgentsCommission`: Comissão a agentes externos na exportação - `StorageHandlingTransportAbroad`: Despesas de armazenagem, movimentação e transporte de carga no exterior - `FifaEventsSubsidiary`: Eventos FIFA (subsidiária) - `FifaEvents`: Eventos FIFA - `FreightsVesselAircraftRentalsOthers`: Fretes, arrendamentos de embarcações ou aeronaves e outros - `AeronauticalMaterial`: Material Aeronáutico - `PromotionGoodsAbroad`: Promoção de Bens no Exterior - `PromotionBrazilianTourism`: Promoção de Destinos Turísticos Brasileiros - `PromotionBrazilAbroad`: Promoção do Brasil no Exterior - `PromotionServicesAbroad`: Promoção de Serviços no Exterior - `Recine`: RECINE - `Recopa`: RECOPA - `TrademarksPatentsCultivars`: Registro e Manutenção de marcas, patentes e cultivares - `Reicomp`: REICOMP - `Reidi`: REIDI - `Repenec`: REPENEC - `Repes`: REPES - `Retaero`: RETAERO - `Retid`: RETID - `RoyaltiesTechnicalAssistance`: Royalties, Assistência Técnica, Científica e Assemelhados - `ConformityAssessmentWto`: Serviços de avaliação da conformidade vinculados aos Acordos da OMC - `Zpe`: ZPE type: string enum: [Unknown, None, PublicAdminAndInternationalRep, LeasesMachineryShipsAircraft, AircraftLeaseAirTransportPublic, ExportAgentsCommission, StorageHandlingTransportAbroad, FifaEventsSubsidiary, FifaEvents, FreightsVesselAircraftRentalsOthers, AeronauticalMaterial, PromotionGoodsAbroad, PromotionBrazilianTourism, PromotionBrazilAbroad, PromotionServicesAbroad, Recine, Recopa, TrademarksPatentsCultivars, Reicomp, Reidi, Repenec, Repes, Retaero, Retid, RoyaltiesTechnicalAssistance, ConformityAssessmentWto, Zpe] temporaryGoods: description: | Vínculo à movimentação temporária de bens (movTempBens). Valores possíveis: - `Unknown`: Desconhecido - `No`: Não - `LinkedImportDeclaration`: Vinculada - Declaração de Importação - `LinkedExportDeclaration`: Vinculada - Declaração de Exportação enum: [Unknown, No, LinkedImportDeclaration, LinkedExportDeclaration] type: string importDeclaration: description: Número da Declaração de Importação (DI/DSI/DA/DRI-E) averbado. type: string maxLength: 60 exportRegistration: description: Número do Registro de Exportação (RE) averbado. type: string maxLength: 60 mdicDelivery: description: Indicador de envio da NFS-e ao MDIC. type: boolean deduction: description: | Grupo de informações relativas aos valores para dedução/redução da base de cálculo do ISSQN (vDR). Aplicado SOMENTE à base de cálculo do ISSQN. Estrutura detalhada alinhada ao padrão da NFS-e Nacional. Quando preenchido, o sistema prioriza estes dados sobre o campo simples `deductionsAmount`. Apenas uma das opções (`rate`, `amount` ou `documents`) deve ser preenchida. type: object properties: rate: format: double description: Percentual padrão de dedução/redução (pDR, %). type: number amount: format: double description: Valor monetário padrão de dedução/redução (vDR, R$). type: number documents: description: Documentos que justificam cada item de dedução/redução (1..1000). type: array items: type: object required: [deductionType, issueDate, deductibleTotal, usedAmount] properties: nfseKey: description: Chave de acesso da NFS-e nacional (50 dígitos). type: string pattern: '^[0-9]{50}$' nfeKey: description: Chave de acesso da NF-e de produto (44 dígitos). type: string pattern: '^[0-9]{44}$' municipalNfse: description: Referência a NFS-e municipal no padrão legado. type: object properties: cityCode: description: Código IBGE do município emissor. type: string number: description: Número da NFS-e municipal. type: string verificationCode: description: Código de verificação. type: string fiscalDocumentNumber: description: Identificador de outro documento fiscal não eletrônico. type: string nonFiscalDocumentNumber: description: 'Identificador de documento não fiscal (ex: nota de débito interna).' type: string deductionType: description: | Tipo da dedução/redução (tpDedRed). Valores aceitos: - `FoodAndBeverages` (1): Alimentação e bebidas/frigobar - `Materials` (2): Materiais - `ConsortiumPassThrough` (5): Repasse consorciado - `HealthPlanPassThrough` (6): Repasse plano de saúde - `Services` (7): Serviços - `Subcontracting` (8): Subempreitada de mão de obra - `Other` (99): Outras deduções — exige `otherDeductionDescription` enum: [FoodAndBeverages, Materials, ConsortiumPassThrough, HealthPlanPassThrough, Services, Subcontracting, Other] type: string otherDeductionDescription: description: Obrigatório quando `deductionType = Other`. type: string maxLength: 150 issueDate: format: date description: Data de emissão do documento de origem (AAAA-MM-DD). type: string deductibleTotal: format: double description: Valor total dedutível/redutível no documento de origem. type: number usedAmount: format: double description: Valor efetivamente utilizado como dedução nesta NFS-e (≤ `deductibleTotal`). type: number supplier: description: Fornecedor do documento (mesma estrutura do `borrower`). type: object properties: type: description: Tipo do fornecedor enum: [Undefined, NaturalPerson, LegalEntity] type: string name: description: Nome / Razão Social type: string maxLength: 115 federalTaxNumber: format: int64 description: CNPJ, CPF ou NIF type: integer municipalTaxNumber: description: Inscrição Municipal type: string maxLength: 12 stateTaxNumber: description: Inscrição Estadual (Opcional) type: string maxLength: 19 taxRegime: description: Tipo do Regime Tributário enum: [Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal] type: string caepf: description: Cadastro de Atividade Econômica da Pessoa Física (CAEPF) type: string maxLength: 14 phoneNumber: description: Telefone type: string email: description: Email type: string noTaxIdReason: description: | Justificativa para ausência de NIF. Valores possíveis: - `NotInformedOriginal`: Não informado na nota de origem - `Exempted`: Dispensado do NIF - `NotRequired`: Não exigência do NIF enum: [NotInformedOriginal, Exempted, NotRequired] type: string address: description: Endereço type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF type: string benefit: description: Benefício Municipal aplicado à base de cálculo do ISSQN (BM). Deve conter `id` e exatamente um entre `amount` ou `rate`. type: object required: [id] properties: id: description: 'Identificador do benefício (nBM: IBGE[7] + tipo[2] + seq[5]).' type: string pattern: '^\d{14}$' amount: format: double description: Redução da BC por valor (vRedBCBM, R$). type: number rate: format: double description: Redução da BC por percentual (pRedBCBM, %). type: number suspension: description: Suspensão da exigibilidade do ISSQN (exigSusp). type: object required: [reason, processNumber] properties: reason: description: | Motivo da suspensão (tpSusp). Valores possíveis: - `Judicial`: Exigibilidade Suspensa por Decisão Judicial - `Administrative`: Exigibilidade Suspensa por Processo Administrativo enum: [Judicial, Administrative] type: string processNumber: description: Número do processo (nProcesso). type: string maxLength: 30 serviceAmountDetails: description: 'Detalhes dos valores do serviço, incluindo encargos. (Versão 2.0 SP)' type: object properties: initialChargedAmount: format: double description: Valor Inicial Cobrado (ValorInicialCobrado) — valor dos serviços antes de tributos, multa e juros. type: number finalChargedAmount: format: double description: Valor Final Cobrado (ValorFinalCobrado) — valor total cobrado pela prestação do serviço, incluindo todos os tributos. type: number fineAmount: format: double description: Valor da Multa (ValorMulta). type: number interestAmount: format: double description: Valor dos Juros (ValorJuros). type: number additionalInformationGroup: description: | Estrutura para envio de informações adicionais em campos específicos (ART/RRT, pedido, etc). Quando `additionalInformation` (texto simples) é preenchido, seu conteúdo é automaticamente copiado para `additionalInformationGroup.otherInformation`. type: object properties: responsibilityDocumentIdentifier: description: 'Identificador do documento de responsabilidade técnica (ART, RRT, etc.).' type: string referencedDocument: description: Documento de referência relacionado ao serviço prestado. type: string order: description: Número do pedido/ordem de compra/ordem de serviço. type: string items: description: Grupo de itens do pedido/ordem de compra/ordem de serviço. type: array items: type: object properties: item: description: Item do pedido/ordem de compra/ordem de serviço. type: string otherInformation: description: Outras informações complementares. type: string approximateTotals: description: | Totais aproximados dos tributos (Lei 12.741/2012) com detalhamento por esfera (totTrib). Granularidade maior que o campo `approximateTax`. Se ambos forem preenchidos, o sistema prioriza `approximateTotals`. Se nenhum for preenchido, o cálculo é realizado automaticamente e preenche o grupo `approximateTax`. type: object properties: federal: description: Tributos federais. type: object properties: rate: format: double description: Percentual total aproximado dos tributos federais (%) (pTotTribFed). type: number minimum: 0 amount: format: double description: Valor total aproximado dos tributos federais (R$) (vTotTribFed). type: number minimum: 0 state: description: Tributos estaduais. type: object properties: rate: format: double description: Percentual total aproximado dos tributos estaduais (%). type: number minimum: 0 amount: format: double description: Valor total aproximado dos tributos estaduais (R$). type: number minimum: 0 municipal: description: Tributos municipais. type: object properties: rate: format: double description: Percentual total aproximado dos tributos municipais (%) (pTotTribMun). type: number minimum: 0 amount: format: double description: Valor total aproximado dos tributos municipais (R$) (vTotTribMun). type: number minimum: 0 rate: format: double description: Percentual total aproximado dos tributos (%). type: number minimum: 0 amount: format: double description: Valor total aproximado dos tributos (R$). type: number minimum: 0 ibsCbs: description: | Informações referentes ao IBS (Imposto sobre Bens e Serviços) e à CBS (Contribuição sobre Bens e Serviços), tributos introduzidos pela Reforma Tributária. (IBSCBS) **Campos obrigatórios:** `classCode` e `operationIndicator`. type: object required: [classCode, operationIndicator] properties: purpose: description: | Finalidade da emissão da NFS-e (finNFe). Valores possíveis: - `regular`: Regular enum: [regular] default: regular type: string destinationIndicator: description: | Relação entre destinatário e comprador/tomador indicado na NFS-e (indDest). Quando `DifferentFromBuyer`, o grupo `recipient` torna-se obrigatório. Valores possíveis: - `SameAsBuyer`: O destinatário é o mesmo que o comprador/tomador - `DifferentFromBuyer`: O destinatário é diferente do comprador/tomador enum: [SameAsBuyer, DifferentFromBuyer] default: SameAsBuyer type: string basis: format: double description: Base de cálculo antes de reduções para cálculo do tributo bruto (vBC). type: number reimbursedResuppliedAmount: format: double description: Montante relativo a reembolso/repasse/ressarcimento não integrante da BC (vReembRepasse). type: number ibscbsDeductionReductionAmount: format: double description: Valor monetário (R$) total relativo aos valores de dedução e redução da Base de Cálculo do IBS e da CBS (vCalcDedRedIBSCBS). type: number isDonation: description: Indica se a operação é uma doação (indDoacao). type: boolean nullable: true personalUse: description: | Indicador de uso ou consumo pessoal do adquirente (indFinal). Crucial para regras tributárias específicas, como a não geração de crédito de IBS/CBS para o tomador. type: boolean nullable: true operationIndicator: description: | Código que define a natureza e o local de incidência do IBS/CBS (cIndOp). Determina onde o imposto é devido — município do imóvel, estabelecimento do fornecedor, endereço do adquirente, local do evento, etc. A lista completa de valores pode ser consultada na Tabela de [operationIndicator](https://nfe.io/docs/documentacao/reforma-tributaria/conceitos-funcionais/documentacao-layout-nfse-rtc/#tabela-de-operationindicator). type: string maxLength: 7 operationType: description: | Tipo de Operação com Entes Governamentais ou outros serviços sobre bens imóveis (tpOper). Valores possíveis: - `SupplyFirstPayLater`: Fornecimento com pagamento posterior - `PayForPastSupply`: Recebimento do pagamento com fornecimento já realizado - `SupplyForPastPay`: Fornecimento com pagamento já realizado - `PayFirstSupplyLater`: Recebimento do pagamento com fornecimento posterior - `SupplyPayTogether`: Fornecimento e recebimento do pagamento concomitantes enum: [SupplyFirstPayLater, PayForPastSupply, SupplyForPastPay, PayFirstSupplyLater, SupplyPayTogether] type: string situationCode: description: | Código de Situação Tributária do IBS/CBS. Opcional. Quando não preenchido, será derivado dos 3 primeiros caracteres de `classCode`. Lista completa em [situationCode](https://nfe.io/docs/documentacao/reforma-tributaria/conceitos-funcionais/documentacao-layout-nfse-rtc/#tabela-de-situationcode). type: string classCode: description: | Código de Classificação Tributária do IBS/CBS (cClassTrib). Lista completa em [classCode](https://nfe.io/docs/documentacao/reforma-tributaria/conceitos-funcionais/documentacao-layout-nfse-rtc/#tabela-de-classcode). type: string maxLength: 6 relatedDocs: description: Grupo de NFS-e referenciadas (gRefNFSe). type: object properties: items: description: Chaves de NFS-e referenciadas (refNFSe). type: array maxItems: 99 items: type: string maxLength: 50 leasedMovableAssets: description: 'Grupo de informações relativas aos bens móveis objetos de locação (gLocBensMoveis). Admitido apenas quando `cTribNac = 99.04.01`.' type: array minItems: 0 maxItems: 99 items: type: object properties: ncmCode: description: Código NCM do bem móvel objeto da locação (cNCMBemMovel). type: string maxLength: 8 description: description: Descrição do bem móvel objeto da locação (xNCMBemMovel). type: string maxLength: 150 quantity: format: int32 description: Quantidade do bem móvel objeto da locação (qtdNCMBemMovel). type: integer realEstate: description: 'Operações relacionadas a bens imóveis dentro do IBS/CBS. Apenas uma das opções (`cibCode` ou `siteAddress`) deve ser preenchida.' type: object properties: propertyFiscalRegistration: description: Inscrição imobiliária fiscal (inscImobFisc). type: string maxLength: 60 cibCode: description: Código do Cadastro Imobiliário Brasileiro (cCIB). type: string maxLength: 30 siteAddress: description: Endereço do imóvel. type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999) ou Código de Endereçamento Postal no exterior' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF (ou Estado, Província, Região no exterior) type: string ibs: description: 'Alíquotas e total do IBS por esfera subnacional (estadual + municipal).' type: object required: [totalAmount, state, municipal] properties: totalAmount: format: double description: 'Total do IBS (vIBSTot = vIBSUF + vIBSMun).' type: number state: description: IBS na esfera estadual. type: object required: [rate, effectiveRate] properties: rate: format: double description: Alíquota IBS UF (%) (pAliqIBSUF). type: number rateReduction: format: double description: Redução de alíquota estadual (%). type: number default: 0 effectiveRate: format: double description: 'pAliqEfetUF = rate × (1 − rateReduction). Se rateReduction ausente, usar rate.' type: number deferment: description: Diferimento do IBS na esfera estadual. type: object properties: rate: format: double description: Percentual de diferimento (pDif, %). type: number amount: format: double description: Valor do diferimento (vDif). type: number returnedAmount: format: double description: Valor de imposto devolvido/devolução (vDevTrib) na esfera estadual. type: number amount: format: double description: Valor do IBS da UF (vIBSUF). type: number municipal: description: IBS na esfera municipal. type: object required: [rate, effectiveRate] properties: rate: format: double description: Alíquota IBS Município (%) (pAliqIBSMun). type: number rateReduction: format: double description: Redução de alíquota municipal (%). type: number default: 0 effectiveRate: format: double description: 'pAliqEfetMun = rate × (1 − rateReduction). Se rateReduction ausente, usar rate.' type: number deferment: description: Diferimento do IBS na esfera municipal. type: object properties: rate: format: double description: Percentual de diferimento (pDif, %). type: number amount: format: double description: Valor do diferimento (vDif). type: number returnedAmount: format: double description: Valor de imposto devolvido/devolução (vDevTrib) na esfera municipal. type: number amount: format: double description: Valor do IBS do Município (vIBSMun). type: number cbs: description: 'Alíquotas da CBS (esfera federal).' type: object required: [rate, effectiveRate] properties: rate: format: double description: Alíquota da CBS (%) (pAliqCBS). type: number rateReduction: format: double description: Redução de alíquota da CBS (%). type: number default: 0 effectiveRate: format: double description: 'pAliqEfetCBS = rate × (1 − rateReduction). Se rateReduction ausente, usar rate.' type: number deferment: description: Diferimento da CBS. type: object properties: rate: format: double description: Percentual de diferimento (pDif, %). type: number amount: format: double description: Valor do diferimento (vDif). type: number returnedAmount: format: double description: Valor de imposto devolvido/devolução da CBS (vDevTrib). type: number amount: format: double description: Valor total da CBS (vCBS). type: number regularTaxation: description: Tributação regular hipotética caso condição resolutória/suspensiva não se aplique. (tpGTribRegular) type: object properties: situationCode: description: CST regular (CSTReg), 3 dígitos. type: string classCode: description: Classificação tributária regular (cClassTribReg), 6 dígitos. type: string ibs: type: object properties: totalAmount: format: double description: Total do IBS regular (vIBSTotReg). type: number state: type: object properties: effectiveRate: format: double description: Alíquota efetiva IBS UF (pAliqEfetRegIBSUF). type: number amount: format: double description: IBS UF regular (vTribRegIBSUF). type: number municipal: type: object properties: effectiveRate: format: double description: Alíquota efetiva IBS Município (pAliqEfetRegIBSMun). type: number amount: format: double description: IBS Município regular (vTribRegIBSMun). type: number cbs: type: object properties: effectiveRate: format: double description: Alíquota efetiva CBS (pAliqEfetRegCBS). type: number amount: format: double description: CBS regular (vTribRegCBS). type: number presumedCredits: description: Créditos presumidos de IBS e CBS quando aplicáveis. type: object properties: ibs: type: object properties: code: description: Código do crédito presumido IBS (cCredPres). type: string pattern: '^\d{2}$' rate: format: double description: Percentual do crédito presumido IBS (pCredPres). type: number amount: format: double description: Valor do crédito presumido IBS (vCredPres). type: number conditionalAmount: format: double description: Valor do crédito presumido IBS sob condição suspensiva (vCredPresCondSus). type: number cbs: type: object properties: code: description: Código do crédito presumido CBS (cCredPres). type: string pattern: '^\d{2}$' rate: format: double description: Percentual do crédito presumido CBS (pCredPres). type: number amount: format: double description: Valor do crédito presumido CBS (vCredPres). type: number conditionalAmount: format: double description: Valor do crédito presumido CBS sob condição suspensiva (vCredPresCondSus). type: number governmentPurchase: description: Composição do valor de IBS e CBS em compras governamentais. type: object properties: entityType: description: | Tipo do ente da compra governamental (tpEnteGov). Valores possíveis: - `Union`: União - `State`: Estado - `FederalDistrict`: Distrito Federal - `Municipality`: Município enum: [Union, State, FederalDistrict, Municipality] type: string operationType: description: | Tipo de Operação com Entes Governamentais (tpOperGov). Valores possíveis: - `SupplyFirstPayLater`: Fornecimento com pagamento posterior - `PayForPastSupply`: Pagamento de fornecimento anterior - `SupplyForPastPay`: Fornecimento com pagamento antecipado - `SupplyPayTogether`: Fornecimento e pagamento concomitantes enum: [SupplyFirstPayLater, PayForPastSupply, SupplyForPastPay, SupplyPayTogether] type: string ibs: type: object properties: totalAmount: format: double description: Total do IBS em compras governamentais (vIBSTotGov). type: number state: type: object properties: rate: format: double description: Alíquota IBS UF em compras governamentais (pAliqIBSUF). type: number amount: format: double description: Valor IBS UF em compras governamentais (vTribIBSUF). type: number municipal: type: object properties: rate: format: double description: Alíquota IBS Município em compras governamentais (pAliqIBSMun). type: number amount: format: double description: Valor IBS Município em compras governamentais (vTribIBSMun). type: number cbs: type: object properties: rate: format: double description: Alíquota CBS em compras governamentais (pAliqCBS). type: number amount: format: double description: Valor CBS em compras governamentais (vTribCBS). type: number creditTransfer: description: Transferência de créditos de IBS e CBS. type: object properties: ibsAmount: format: double description: Valor de IBS a transferir (vIBS). type: number cbsAmount: format: double description: Valor de CBS a transferir (vCBS). type: number thirdPartyReimbursements: description: Valores de reembolso/repasse/ressarcimento já tributados e aqui referenciados. (tpGrupoReeRepRes) type: object properties: documents: description: Documentos que justificam a exclusão da BC de IBS/CBS/ISS (1..1000). type: array minItems: 1 maxItems: 1000 items: type: object required: [issueDate, accrualOn, reimbursementType, amount] properties: nfseKey: description: Chave NFS-e (padrão nacional). type: string maxLength: 50 nfeKey: description: Chave NF-e (44 dígitos). type: string pattern: '^[0-9]{44}$' cteKey: description: Chave CT-e (44 dígitos). type: string pattern: '^[0-9]{44}$' otherNationalDfe: description: Outro DF-e presente no repositório nacional. type: object required: [dfeKey, dfeTypeText] properties: dfeKey: description: Chave do DF-e (chDFE). type: string maxLength: 50 dfeTypeText: description: Tipo do DF-e (xTpDFE). type: string maxLength: 255 dfeType: description: Documento fiscal a que se refere a chaveDfe (tipoChaveDFE). type: string maxLength: 1 otherFiscalDoc: description: Documento fiscal que não está no repositório nacional (eletrônico ou não). type: object required: [issuerCityCode, fiscalDocNumber] properties: issuerCityCode: description: Código IBGE do município emissor do documento fiscal. type: string fiscalDocNumber: description: Número do documento fiscal. type: string maxLength: 255 fiscalDocDescription: description: Descrição do documento fiscal. type: string maxLength: 255 otherDoc: description: Documento não fiscal. type: object required: [docNumber, docDescription] properties: docNumber: description: Número do documento. type: string maxLength: 255 docDescription: description: Descrição do documento. type: string maxLength: 255 supplier: description: Fornecedor/emitente do documento referenciado (mesma estrutura do `borrower`). type: object properties: type: description: Tipo do fornecedor enum: [Undefined, NaturalPerson, LegalEntity] type: string name: description: Nome / Razão Social type: string maxLength: 115 federalTaxNumber: format: int64 description: CNPJ, CPF ou NIF type: integer municipalTaxNumber: description: Inscrição Municipal type: string maxLength: 12 stateTaxNumber: description: Inscrição Estadual (Opcional) type: string maxLength: 19 taxRegime: description: Tipo do Regime Tributário enum: [Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal] type: string caepf: description: Cadastro de Atividade Econômica da Pessoa Física (CAEPF) type: string maxLength: 14 phoneNumber: description: Telefone type: string email: description: Email type: string noTaxIdReason: description: | Justificativa para ausência de NIF. Valores possíveis: - `NotInformedOriginal`: Não informado na nota de origem - `Exempted`: Dispensado do NIF - `NotRequired`: Não exigência do NIF enum: [NotInformedOriginal, Exempted, NotRequired] type: string address: description: Endereço type: object properties: country: description: 'Sigla do País (padrão ISO 3166-1). Exemplo: BRA, USA, ARG' type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10)' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado/UF type: string issueDate: format: date description: Data de emissão (AAAA-MM-DD). type: string accrualOn: format: date description: Data de competência (AAAA-MM-DD). type: string reimbursementType: description: | Motivo do reembolso/repasse/ressarcimento (tpReemb). Valores possíveis: - `RealEstateBrokerPassThrough`: Repasse de corretagem de imóveis - `TravelAgencySupplierPassThrough`: Repasse de valores de fornecedores em agência de viagens - `AdAgencyExternalProductionReimbursement`: Reembolso de produção externa em agência de publicidade - `AdAgencyMediaReimbursement`: Reembolso de despesas com mídia em agência de publicidade - `OtherReimbursement`: Outros reembolsos ou ressarcimentos enum: [RealEstateBrokerPassThrough, TravelAgencySupplierPassThrough, AdAgencyExternalProductionReimbursement, AdAgencyMediaReimbursement, OtherReimbursement] type: string reimbursementTypeText: description: Obrigatório quando `reimbursementType = OtherReimbursement` (xReembOutros). type: string maxLength: 150 amount: format: double description: 'Valor considerado para exclusão da BC (total ou parcial, R$) (vReemb).' type: number responses: "202": description: Nota Fiscal de Serviços foi enviada com sucesso para fila de emissão content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string flowStatus: description: | Status do processamento da NFS-e no fluxo de emissão. Valores possíveis: - `CancelFailed` (-2): Falha no cancelamento — tentativa de cancelar a NFS-e foi rejeitada - `IssueFailed` (-1): Falha na emissão — a NFS-e não foi autorizada pela Prefeitura - `Issued` (1): Emitida — autorizada pela Prefeitura - `Cancelled` (2): Cancelada - `PullFromCityHall` (3): Capturada da Prefeitura (sincronização de NFS-e já emitida fora da plataforma) - `WaitingCalculateTaxes` (10): Aguardando cálculo de tributos - `WaitingDefineRpsNumber` (11): Aguardando definição do número da RPS - `WaitingSend` (12): Aguardando envio à Prefeitura - `WaitingSendCancel` (13): Aguardando envio do cancelamento à Prefeitura - `WaitingReturn` (14): Aguardando retorno da Prefeitura - `WaitingDownload` (15): Aguardando download do XML/PDF enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endere o required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: | Tipo da tributação do ISSQN (TributacaoRPS). Valores possíveis: - `None`: Nenhuma - `WithinCity`: Tributação dentro do mesmo município - `OutsideCity`: Tributação fora do município - `Export`: Exportação - `Free`: Isento - `Immune`: Imune - `SuspendedCourtDecision`: Exigibilidade suspensa por decisão judicial - `SuspendedAdministrativeProcedure`: Exigibilidade suspensa por procedimento administrativo - `OutsideCityFree`: Tributação fora do município porém isento - `OutsideCityImmune`: Tributação fora do município porém imune - `OutsideCitySuspended`: Tributação fora do município porém suspensa - `OutsideCitySuspendedAdministrativeProcedure`: Tributação fora do município, suspensa por procedimento administrativo - `ObjectiveImune`: Tributação no município com indicação de imunidade objetiva enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/external/{id}: get: tags: - ServiceInvoices summary: Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) através do ID externo (externalId) description: Você precisará do API Key da Empresa operationId: ServiceInvoices_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: externalId in: path description: ID externo da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string flowStatus: description: | Status do processamento da NFS-e no fluxo de emissão. Valores possíveis: - `CancelFailed` (-2): Falha no cancelamento — tentativa de cancelar a NFS-e foi rejeitada - `IssueFailed` (-1): Falha na emissão — a NFS-e não foi autorizada pela Prefeitura - `Issued` (1): Emitida — autorizada pela Prefeitura - `Cancelled` (2): Cancelada - `PullFromCityHall` (3): Capturada da Prefeitura (sincronização de NFS-e já emitida fora da plataforma) - `WaitingCalculateTaxes` (10): Aguardando cálculo de tributos - `WaitingDefineRpsNumber` (11): Aguardando definição do número da RPS - `WaitingSend` (12): Aguardando envio à Prefeitura - `WaitingSendCancel` (13): Aguardando envio do cancelamento à Prefeitura - `WaitingReturn` (14): Aguardando retorno da Prefeitura - `WaitingDownload` (15): Aguardando download do XML/PDF enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: | Tipo da tributação do ISSQN (TributacaoRPS). Valores possíveis: - `None`: Nenhuma - `WithinCity`: Tributação dentro do mesmo município - `OutsideCity`: Tributação fora do município - `Export`: Exportação - `Free`: Isento - `Immune`: Imune - `SuspendedCourtDecision`: Exigibilidade suspensa por decisão judicial - `SuspendedAdministrativeProcedure`: Exigibilidade suspensa por procedimento administrativo - `OutsideCityFree`: Tributação fora do município porém isento - `OutsideCityImmune`: Tributação fora do município porém imune - `OutsideCitySuspended`: Tributação fora do município porém suspensa - `OutsideCitySuspendedAdministrativeProcedure`: Tributação fora do município, suspensa por procedimento administrativo - `ObjectiveImune`: Tributação no município com indicação de imunidade objetiva enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}: get: tags: - ServiceInvoices summary: Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) description: Você precisará do API Key da Empresa operationId: ServiceInvoices_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: | Ambiente de processamento da nota fiscal. Valores possíveis: - `Development`: Desenvolvimento (uso interno/sandbox) - `Production`: Produção — emite nota com validade fiscal - `Staging`: Homologação — emite nota apenas para testes, sem validade fiscal enum: - Development - Production - Staging type: string flowStatus: description: | Status do processamento da NFS-e no fluxo de emissão. Valores possíveis: - `CancelFailed` (-2): Falha no cancelamento — tentativa de cancelar a NFS-e foi rejeitada - `IssueFailed` (-1): Falha na emissão — a NFS-e não foi autorizada pela Prefeitura - `Issued` (1): Emitida — autorizada pela Prefeitura - `Cancelled` (2): Cancelada - `PullFromCityHall` (3): Capturada da Prefeitura (sincronização de NFS-e já emitida fora da plataforma) - `WaitingCalculateTaxes` (10): Aguardando cálculo de tributos - `WaitingDefineRpsNumber` (11): Aguardando definição do número da RPS - `WaitingSend` (12): Aguardando envio à Prefeitura - `WaitingSendCancel` (13): Aguardando envio do cancelamento à Prefeitura - `WaitingReturn` (14): Aguardando retorno da Prefeitura - `WaitingDownload` (15): Aguardando download do XML/PDF enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: | Código de Regime Tributário (CRT) da empresa. Valores possíveis: - `Isento`: Isento de tributação - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `SimplesNacional`: Simples Nacional - `LucroPresumido`: Lucro Presumido (Regime Normal) - `LucroReal`: Lucro Real (Regime Normal) enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: | Regime Especial de Tributação (indRegTrib) — aplicável a prestadores de serviços. Valores possíveis: - `Automatico`: Determinação automática pela API conforme cadastro da empresa - `Nenhum`: Sem regime especial de tributação - `MicroempresaMunicipal`: Microempresa Municipal - `Estimativa`: Estimativa fiscal - `SociedadeDeProfissionais`: Sociedade de Profissionais - `Cooperativa`: Cooperativa - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) - `MicroempresarioEmpresaPequenoPorte`: Microempresário e Empresa de Pequeno Porte (ME/EPP) enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: | Código da Natureza Jurídica da empresa, conforme tabela do IBGE. Valores possíveis (principais): - `EmpresaPublica`: Empresa Pública - `SociedadeEconomiaMista`: Sociedade de Economia Mista - `SociedadeAnonimaAberta`: Sociedade Anônima Aberta - `SociedadeAnonimaFechada`: Sociedade Anônima Fechada - `SociedadeEmpresariaLimitada`: Sociedade Empresária Limitada (LTDA) - `Empresario`: Empresário Individual - `Cooperativa`: Cooperativa - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária - `EireliNaturezaSimples`: EIRELI de Natureza Simples - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) - `FundacaoPrivada`: Fundação Privada - `CondominioEdilicio`: Condomínio Edilício - `OrganizacaoReligiosa`: Organização Religiosa - `AssociacaoPrivada`: Associação Privada - `PartidoPolitico`: Partido Político - `EntidadeSindical`: Entidade Sindical - `ComunidadeIndigena`: Comunidade Indígena - `FundoPrivado`: Fundo Privado - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior 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 economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: | Tipo da tributação do ISSQN (TributacaoRPS). Valores possíveis: - `None`: Nenhuma - `WithinCity`: Tributação dentro do mesmo município - `OutsideCity`: Tributação fora do município - `Export`: Exportação - `Free`: Isento - `Immune`: Imune - `SuspendedCourtDecision`: Exigibilidade suspensa por decisão judicial - `SuspendedAdministrativeProcedure`: Exigibilidade suspensa por procedimento administrativo - `OutsideCityFree`: Tributação fora do município porém isento - `OutsideCityImmune`: Tributação fora do município porém imune - `OutsideCitySuspended`: Tributação fora do município porém suspensa - `OutsideCitySuspendedAdministrativeProcedure`: Tributação fora do município, suspensa por procedimento administrativo - `ObjectiveImune`: Tributação no município com indicação de imunidade objetiva enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - ServiceInvoices summary: Cancelar uma Nota Fiscal de Serviços (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Nota fiscal cancelada com sucesso content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/sendemail: put: tags: - ServiceInvoices summary: Enviar email para o Tomador com a Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_SendEmail parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/pdf: get: tags: - ServiceInvoices summary: Download do PDF da Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_GetDocumentPdf parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Não foi possivel o download content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/xml: get: tags: - ServiceInvoices summary: Download do XML da Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_GetDocumentXml parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Não foi possivel o download content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/cancellation-xml: get: tags: - ServiceInvoices summary: Download do XML do evento de cancelamento da Nota Fiscal de Serviço (NFSE) description: "Você precisará do APIKEY da Empresa.\r\nDisponível apenas para o ambiente Nacional (evento de cancelamento `e110001`). Provedores legados (ABRASF, Paulistana e demais padrões municipais) não possuem XML de evento de cancelamento próprio e retornam 404.\r\nQuando existem o XML enviado (request) e o XML do evento autorizado (retorno) pelo Ambiente Nacional, o retorno autorizado é priorizado." operationId: ServiceInvoices_GetCancellationXml parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "401": description: API Key da conta não é valida content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Não há XML de evento de cancelamento para esta nota (provedor legado, ambiente não Nacional ou nota ainda não cancelada) content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" security: - Authorization_Header: [] Authorization_QueryParam: [] /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: description: Tipos de Eventos type: object properties: eventTypes: description: Lista de Evento type: array items: description: Tipo de Evento type: object properties: id: 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**" type: string description: description: Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. type: string status: format: int32 description: WebHook Filter Status enum: - 0 - 1 type: integer "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /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: description: Web Hooks type: object properties: webHooks: description: Lista de Web Hook type: array items: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: 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." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] 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: description: Dados para criar um Web Hook content: application/json: schema: description: Dados para criar um Web Hook type: object properties: webHook: description: Dados para criar um Web Hook required: - uri type: object properties: uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string responses: "201": description: Sucesso na criação da webhook content: application/json: schema: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: 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." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Webhook não encontrado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] 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 "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /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: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: 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." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Webhook não encontrado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] 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 consultado required: true schema: type: string requestBody: description: Dados para alterar o Webhook content: application/json: schema: description: Dados para alterar um Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: 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." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string responses: "200": description: Sucesso na atualização da Webhook content: application/json: schema: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: 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." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: 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." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: 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**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: 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**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: 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." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Webhook não encontrado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] 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 "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Webhook não encontrado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /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 "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "403": description: Accesso proibido content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "404": description: Webhook não encontrado content: application/json: schema: $ref: "#/components/schemas/ErrorsResource" "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] components: schemas: ErrorsResource: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string securitySchemes: Authorization_Header: name: Authorization in: header type: apiKey description: 'Autenticar usando o Cabeçalho HTTP Authorization com sua API Key' Authorization_QueryParam: name: apikey in: query type: apiKey description: 'Autenticar usando o Parametro na URL, exemplo: "/?apikey={APIKEY_TOKEN}"'