diff --git a/openapi/consulta-cnpj-v3.yaml b/openapi/consulta-cnpj-v3.yaml index b631c0c..01eab7b 100644 --- a/openapi/consulta-cnpj-v3.yaml +++ b/openapi/consulta-cnpj-v3.yaml @@ -1,1129 +1,613 @@ -swagger: "2.0" +openapi: 3.0.4 info: - version: v2 - title: Legal Entities API - x-sidebarLabel: Introdução - x-description: Teste - description:

Como utilizar esta documentação ?

Certifique-se que sua chave da API está preenchida no topo desta página para este recurso funcionar da maneira correta. Abaixo você poderá conferir a lista de recursos que podem ser manipulados através da API. Clicando em cada um dos métodos, você poderá verificar a lista de parâmetros, possíveis retornos e também um formulário. Este formulário pode ser utilizado para efetuar requisições reais na API.

-host: legalentity.api.nfe.io + title: 'Consulta de Pessoa Jurídica' + description: "# Introdução\r\n\r\nSeja bem-vindo a documentação da API de consulta de Pessoa Jurídica!\r\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.\r\n\r\n# Como usar a API?\r\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.\r\n\r\n# Autenticação\r\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API.\r\nPara isso você deve colocar sua chave de API no campo que se encontra no topo desta página para que os métodos funcionem corretamente.\r\nNo seu código de integração temos suporte para autenticação de diversas formas sendo eles:\r\nHTTP Header (Authorization ou X-NFEIO-APIKEY) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).\n\n> **Contrato alfanumérico** — aceita CNPJ com letras (formato pós IN RFB nº 2.229/2024)." + version: '3.0' paths: - /v2/legalentities/basicInfo/{federalTaxNumber}: + '/v3/legalentities/basicInfo/{federalTaxNumber}': get: tags: - LegalEntities - summary: Consulta de dados do CNPJ - description: Você precisará do APIKEY da Empresa - operationId: V2LegalentitiesBasicInfoByFederalTaxNumberGet - consumes: [] - produces: - - application/json + summary: 'Consulta de dados do CNPJ (aceita CNPJ alfanumérico)' + description: 'Você precisará do APIKEY da Empresa' parameters: - - name: federalTaxNumber + - + name: federalTaxNumber in: path - description: CNPJ + description: 'CNPJ (numérico ou alfanumérico)' required: true - type: integer - format: int64 - - name: updateAddress - in: query - description: 'Define se deseja ou não atualizar o endereço do cartão CNPJ com base nos correios (Default: true)' - required: false - type: boolean - - name: updateCityCode - in: query - description: 'Quando updateAddress=false, define se deseja ou não atualizar somente o código da cidade utilizando o código postal com base nos correios (Default: false)' - required: false - type: boolean - responses: - "200": - description: Sucesso na requisição - schema: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.LegalPersonResourceV2' - "400": - description: Algum parametro informado não é válido schema: type: string - "401": - description: Não autorizado, verificar o cabeçalho do HTTP Authorization - "403": - description: Accesso proibido - "404": - description: Empresa não encontrada para o CNPJ informado + - + name: updateAddress + in: query + description: 'Atualiza o endereço com base nos correios (Default: true)' schema: - type: string - "500": - description: Erro no processamento + type: boolean + default: true + - + name: updateCityCode + in: query + description: 'Quando updateAddress=false, atualiza apenas o código da cidade (Default: false)' schema: - type: string - security: - - Authorization_Header: - - CheckClaimOrRole - - Authorization_QueryParam: - - CheckClaimOrRole - /v2/legalentities/stateTaxInfo/{state}/{federalTaxNumber}: - get: - tags: - - LegalEntities - summary: Consulta de Inscrição Estadual por CNPJ - description: Você precisará do APIKEY da Empresa - operationId: V2LegalentitiesStateTaxInfoByStateByFederalTaxNumberGet - consumes: [] - produces: - - application/json - parameters: - - name: state - in: path - description: Código do IBGE do Estado que deseja consultar - required: true - type: string - enum: - - AC - - AL - - AM - - AP - - BA - - CE - - DF - - ES - - GO - - MA - - MG - - MS - - MT - - PA - - PB - - PE - - PI - - PR - - RJ - - RN - - RO - - RR - - RS - - SC - - SE - - SP - - TO - - EX - - NA - - name: federalTaxNumber - in: path - description: Número do documento que deseja consultar - required: true - type: integer - format: int64 + type: boolean + default: false responses: - "200": - description: Sucesso na requisição - schema: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxResourceV2' - "400": - description: Algum parametro informado não é válido - schema: - type: string - "401": - description: Não autorizado, verificar o cabeçalho do HTTP Authorization - "500": - description: Erro no processamento - schema: - type: string - "403": - description: Accesso proibido - security: - - Authorization_Header: - - CheckClaimOrRole - - Authorization_QueryParam: - - CheckClaimOrRole - /v2/legalentities/stateTaxForInvoice/{state}/{federalTaxNumber}: + 200: + description: 'Sucesso na requisição' + content: + application/json: + schema: + $ref: '#/components/schemas/LegalPersonResourceV3' + 400: + description: 'Algum parametro informado não é válido' + content: + application/json: + schema: + type: string + 401: + description: 'API Key da conta não é valida' + content: + application/json: + schema: + type: string + 403: + description: 'API Key não tem permissão para acesso' + content: + application/json: + schema: + type: string + 404: + description: 'Empresa não encontrada para o CNPJ informado' + content: + application/json: + schema: + type: string + 500: + description: 'Erro no processamento' + content: + application/json: + schema: + type: string + '/v3/legalentities/stateTaxInfo/{state}/{federalTaxNumber}': get: tags: - LegalEntities - summary: Consulta de Inscrição Estadual por CNPJ para avalição de Emissão de Nota Fiscal de Produto - description: Você precisará do APIKEY da Empresa - operationId: V2LegalentitiesStateTaxForInvoiceByStateByFederalTaxNumberGet - consumes: [] - produces: - - application/json + summary: 'Consulta de Inscrição Estadual por CNPJ (aceita CNPJ alfanumérico)' + description: 'Você precisará do APIKEY da Empresa' parameters: - - name: state + - + name: state in: path - description: Código do IBGE do Estado que deseja consultar + description: 'Código do IBGE do Estado que deseja consultar' required: true - type: string - enum: - - AC - - AL - - AM - - AP - - BA - - CE - - DF - - ES - - GO - - MA - - MG - - MS - - MT - - PA - - PB - - PE - - PI - - PR - - RJ - - RN - - RO - - RR - - RS - - SC - - SE - - SP - - TO - - EX - - NA - - name: federalTaxNumber + schema: + $ref: '#/components/schemas/StateCode' + - + name: federalTaxNumber in: path - description: Número do documento que deseja consultar + description: 'CNPJ (numérico ou alfanumérico)' required: true - type: integer - format: int64 - responses: - "200": - description: Sucesso na requisição - schema: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceCompleteResource' - "400": - description: Algum parametro informado não é válido - schema: - type: string - "401": - description: Não autorizado, verificar o cabeçalho do HTTP Authorization - "500": - description: Erro no processamento schema: type: string - "403": - description: Accesso proibido - security: - - Authorization_Header: - - CheckClaimOrRole - - Authorization_QueryParam: - - CheckClaimOrRole - /v2/legalentities/stateTaxSuggestedForInvoice/{state}/{federalTaxNumber}: - get: - tags: - - LegalEntities - summary: "Consulta de Inscrição Estadual por CNPJ para avalição de Emissão de Nota Fiscal de Produto\r\nCaso existir mais de uma HABILITADA, será retornado a melhor inscrição estadual para emitir nota em critério de avaliação da NFE.io" - description: Você precisará do APIKEY da Empresa - operationId: V2LegalentitiesStateTaxSuggestedForInvoiceByStateByFederalTaxNumberGet - consumes: [] - produces: - - application/json - parameters: - - name: state - in: path - description: Código do IBGE do Estado que deseja consultar - required: true + responses: + 200: + description: 'Sucesso na requisição' + content: + application/json: + schema: + $ref: '#/components/schemas/StateTaxResourceV3' + 400: + description: 'Algum parametro informado não é válido' + content: + application/json: + schema: + type: string + 401: + description: 'API Key da conta não é valida' + content: + application/json: + schema: + type: string + 500: + description: 'Erro no processamento' + content: + application/json: + schema: + type: string +components: + schemas: + AddressResourceItem: + type: object + properties: + state: type: string - enum: - - AC - - AL - - AM - - AP - - BA - - CE - - DF - - ES - - GO - - MA - - MG - - MS - - MT - - PA - - PB - - PE - - PI - - PR - - RJ - - RN - - RO - - RR - - RS - - SC - - SE - - SP - - TO - - EX - - NA - - name: federalTaxNumber - in: path - description: Número do documento que deseja consultar - required: true + description: Estado + nullable: true + city: + $ref: '#/components/schemas/CityBase' + district: + type: string + description: Bairro + nullable: true + additionalInformation: + type: string + description: 'Informações adicionais' + nullable: true + streetSuffix: + type: string + description: 'Sufixo da rua' + nullable: true + street: + type: string + description: 'Nome da rua' + nullable: true + number: + type: string + description: Número + nullable: true + numberMin: + type: string + nullable: true + numberMax: + type: string + nullable: true + postalCode: + type: string + description: CEP + nullable: true + country: + type: string + description: País + nullable: true + additionalProperties: false + description: Endereço + CityBase: + type: object + properties: + code: + type: string + description: 'Código do município (cMun)' + nullable: true + name: + type: string + description: 'Nome do município (xMun)' + nullable: true + additionalProperties: false + EconomicActivityResource: + type: object + properties: + type: + $ref: '#/components/schemas/EconomicActivityType' + code: type: integer - format: int64 - responses: - "200": - description: Sucesso na requisição - schema: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceCompleteResource' - "400": - description: Algum parametro informado não é válido - schema: - type: string - "401": - description: Não autorizado, verificar o cabeçalho do HTTP Authorization - "500": - description: Erro no processamento - schema: - type: string - "403": - description: Accesso proibido - security: - - Authorization_Header: - - CheckClaimOrRole - - Authorization_QueryParam: - - CheckClaimOrRole -definitions: - DataTech.Api.Resources.LegalEntities.TaxRegimeResource: - type: object - properties: - createdOn: - format: date-time - description: 'Data de Consulta do usuário - Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.' - type: string - optedInOn: - format: date-time - description: 'Data de opção pelo atual Regime Tributário - Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.' - type: string - taxRegime: - description: Regime Tributário Atual - type: string - name: - description: Razão social - type: string - federalTaxNumber: - description: Número da inscrição na Receita Federal (CNPJ) - type: string - previousDetails: - description: Lista de Períodos Anteriores - type: array - items: - $ref: '#/definitions/DataTech.Services.Domain.Models.SimplesNacionalScrapOutItem+History' - DataTech.Services.Domain.Models.SimplesNacionalScrapOutItem+History: - type: object - properties: - taxRegime: - description: Regime Tributário - type: string - beginOn: - format: date-time - description: 'Data Inicial - Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.' - type: string - endOn: - format: date-time - description: 'Data Final - Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.' - type: string - description: - description: Detalhamento - type: string - DataTech.Api.Resources.LegalEntities.LegalPersonResource: - type: object - properties: - tradeName: - description: Nome fantasia - type: string - name: - description: Razão social - type: string - federalTaxNumber: - description: Número da inscrição na Receita Federal (CNPJ) - type: string - size: - description: Porte - type: string - openedOn: - format: date-time - description: Data da abertura - type: string - address: - $ref: '#/definitions/DataTech.Services.Domain.Models.Address' - description: Endereço - phones: - description: Número de telefone - type: array - items: - $ref: '#/definitions/DataTech.Services.Domain.Models.Phone' - statusOn: - format: date-time - description: Data da situação cadastral - type: string - status: - description: Situação cadastral - type: string - email: - description: Correio eletrônico - type: string - responsableEntity: - description: Ente Federativo Responsável (EFR) - type: string - specialStatus: - description: Situação Especial - type: string - specialStatusOn: - format: date-time - description: Data da Situação Especial - type: string - issuedOn: - format: date-time - description: Data de Consulta do usuário - type: string - statusReason: - description: Motivo da Situação Cadastral - type: string - shareCapital: - format: double - description: Capital sócial (em reais) - type: number - economicActivities: - description: Objeto com Código e descrição das atividades econômicas principal e secundárias - type: array - items: - $ref: '#/definitions/DataTech.Services.Domain.Models.Activity' - legalNature: - $ref: '#/definitions/DataTech.Services.Domain.Models.Item' - description: Objeto com Código e descrição da Natureza Legal - partners: - description: Objeto com nome e qualificação dos sócios e administradores - type: array - items: - $ref: '#/definitions/DataTech.Services.Domain.Models.Partner' - registrationUnit: - description: Objeto com a cidade/unidade registradora do certificado de baixa - type: string - unit: - description: Objeto que define se é matriz, filial ou sucursal - enum: - - Headoffice - - Subsidiary - type: string - DataTech.Services.Domain.Models.Address: - type: object - properties: - state: - description: Estado (UF) - type: string - city: - $ref: '#/definitions/DataTech.Services.Domain.Models.CityBase' - description: Cidade - district: - description: Bairro (xBairro) - type: string - additionalInformation: - description: Complemento (xCpl) - type: string - streetSuffix: - description: Tipo do Logradouro - type: string - street: - description: Logradouro do Endereco (xLgr) - type: string - number: - description: Número (nro) - type: string - postalCode: - description: Código Endereço Postal (CEP) - type: string - country: - description: País - type: string - DataTech.Services.Domain.Models.Phone: - type: object - properties: - ddd: - description: Prefixo - type: string - number: - description: Número do telefone - type: string - source: - description: Origem da Informação - enum: - - RFB - type: string - DataTech.Services.Domain.Models.Activity: - type: object - properties: - isMain: - description: Verificador se é atividade principal ou secundária - type: boolean - code: - description: Código da Atividade Econômica - type: string - description: - description: Descrição da Atividade Econômica - type: string - DataTech.Services.Domain.Models.Item: - type: object - properties: - code: - description: Código da Atividade Econômica - type: string - description: - description: Descrição da Atividade Econômica - type: string - DataTech.Services.Domain.Models.Partner: - type: object - properties: - name: - description: Nome/Nome Empresarial - type: string - qualification: - $ref: '#/definitions/DataTech.Services.Domain.Models.Qualification' - description: Qualificação do Quadro de Sócios e Administradores - DataTech.Services.Domain.Models.CityBase: - type: object - properties: - code: - description: Código do município (cMun) - type: string - name: - description: Nome do município (xMun) - type: string - DataTech.Services.Domain.Models.Qualification: - type: object - properties: - code: - description: Código Qualificação do Quadro de Sócios e Administradores - type: string - description: - description: Descrição da Qualificação do Quadro de Sócios e Administradores - type: string - DataTech.Api.Resources.LegalEntities.StateTaxInfoResource: - type: object - properties: - createdOn: - format: date-time - description: Data de Consulta - type: string - name: - description: Razão social - type: string - tradeName: - description: Nome Fantasia - type: string - federalTaxNumber: - description: Número da inscrição na Receita Federal (CNPJ) - type: string - taxPayer: - description: Lista de Contribuites(Inscrição Estadual) - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.TaxPayerResource' - DataTech.Api.Resources.LegalEntities.TaxPayerResource: - type: object - properties: - stateTaxNumber: - description: Inscrição Estadual (IE) - type: string - state: - $ref: '#/definitions/DataTech.Services.Domain.Models.StateBase' - description: Estado (IE) - typeStateTax: - description: Tipo Inscrição Estadual (IE) - type: string - statusOnStateTax: - format: date-time - description: Data da situação na UF - type: string - statusStateTax: - description: Situação IE - type: string - statusFederalTax: - description: Situação CNPJ - type: string - openedOn: - format: date-time - description: Data da abertura - type: string - closedOn: - format: date-time - description: Data fim atividade - type: string - cnae: - format: int64 - description: CNAE fiscal (CNAE) - type: integer - DataTech.Services.Domain.Models.StateBase: - type: object - properties: - code: - type: string - abbreviation: - type: string - name: - type: string - DataTech.Api.Resources.LegalEntities.LegalPersonResourceV2: - type: object - properties: - legalEntity: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.LegalPersonResourceV2Item' - description: Pessoa jurídica - DataTech.Api.Resources.LegalEntities.LegalPersonResourceV2Item: - type: object - properties: - tradeName: - description: Nome fantasia - type: string - name: - description: Razão social - type: string - federalTaxNumber: - format: int64 - description: Número da inscrição na Receita Federal (CNPJ) - type: integer - size: - description: Porte - enum: - - Unknown - - ME - - EPP - - DEMAIS - type: string - openedOn: - format: date-time - description: Data da abertura - type: string - address: - $ref: '#/definitions/DataTech.Api.Resources.AddressResourceItem' - description: Endereço - phones: - description: Número de telefone - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.PhoneResource' - statusOn: - format: date-time - description: Data da situação cadastral - type: string - status: - description: Situação cadastral - enum: - - Unknown - - Active - - Suspended - - Cancelled - - Unabled - - "Null" - type: string - email: - description: Correio eletrônico - type: string - responsableEntity: - description: Ente Federativo Responsável (EFR) - type: string - specialStatus: - description: Situação Especial - type: string - specialStatusOn: - format: date-time - description: Data da Situação Especial - type: string - issuedOn: - format: date-time - description: Data de Consulta do usuário - type: string - statusReason: - description: Motivo da Situação Cadastral - type: string - shareCapital: - format: double - description: Capital sócial (em reais) - type: number - economicActivities: - description: Objeto com Código e descrição das atividades econômicas principal e secundárias - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.EconomicActivityResource' - legalNature: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.LegalEntityNatureResource' - description: Objeto com Código e descrição da Natureza Legal - partners: - description: Objeto com nome e qualificação dos sócios e administradores - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.PartnerResource' - registrationUnit: - description: Objeto com a cidade/unidade registradora do certificado de baixa - type: string - unit: - description: Objeto que define se é matriz, filial ou sucursal - enum: - - Headoffice - - Subsidiary - type: string - DataTech.Api.Resources.AddressResourceItem: - description: Endereço - type: object - properties: - state: - description: Estado - type: string - city: - $ref: '#/definitions/DataTech.Services.Domain.Models.CityBase' - description: Cidade - district: - description: Bairro - type: string - additionalInformation: - description: Informações adicionais - type: string - streetSuffix: - description: Sufixo da rua - type: string - street: - description: Nome da rua - type: string - number: - description: Número - type: string - numberMin: - type: string - numberMax: - type: string - postalCode: - description: CEP - type: string - country: - description: País - type: string - DataTech.Api.Resources.LegalEntities.PhoneResource: - type: object - properties: - ddd: - description: Prefixo - type: string - number: - description: Número do telefone - type: string - source: - description: Origem da Informação - enum: - - RFB - type: string - DataTech.Api.Resources.LegalEntities.EconomicActivityResource: - description: Objeto com Código e descrição das atividades econômicas principal e secundárias - type: object - properties: - type: - description: Classificação da atividade - enum: - - Main - - Secondary - type: string - code: - format: int32 - description: Código da atividade (CNAE) - type: integer - description: - description: Descrição da atividade (CNAE) - type: string - DataTech.Api.Resources.LegalEntities.LegalEntityNatureResource: - type: object - properties: - code: - description: Código da Natureza Legal - type: string - description: - description: Descrição da Natureza Legal - type: string - DataTech.Api.Resources.LegalEntities.PartnerResource: - type: object - properties: - name: - description: Nome/Nome Empresarial - type: string - qualification: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.QualificationResource' - description: Qualificação do Quadro de Sócios e Administradores - DataTech.Api.Resources.LegalEntities.QualificationResource: - type: object - properties: - code: - description: Código Qualificação do Quadro de Sócios e Administradores - type: string - description: - description: Descrição da Qualificação do Quadro de Sócios e Administradores - type: string - DataTech.Api.Resources.LegalEntities.StateTaxResourceV2: - type: object - properties: - legalEntity: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxResourceItemV2' - DataTech.Api.Resources.LegalEntities.StateTaxResourceItemV2: - type: object - properties: - tradeName: - description: Nome fantasia - type: string - name: - description: Razão social - type: string - federalTaxNumber: - format: int64 - description: Número da inscrição na Receita Federal (CNPJ) - type: integer - createdOn: - format: date-time - description: Data de Consulta do usuário - type: string - taxRegime: - description: "Código de Regime Tributário (CRT)\r\n\r\n 0 - Desconhecido (Necessário mapear)\r\n 1 - Simples Nacional\r\n 2 - MEI\r\n 3 - Regime Normal - Lucro Presumido ou Lucro Real (Normal_Regime)\r\n" - enum: - - Unknown - - SimplesNacional - - MEI - - Normal - type: string - legalNature: - description: Código da Natureza Jurídica - 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 - - OutrasSemFimLucrativo - - Unknown - type: string - fiscalUnit: - description: Unidade de fiscalização - type: string - createdUnit: - description: Unidade de cadastro - type: string - checkCode: - description: Código de verificação - type: string - stateTaxes: - description: Inscrições estaduais - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxResource' - DataTech.Api.Resources.LegalEntities.StateTaxResource: - description: Inscrições estaduais - type: object - properties: - status: - description: Situação cadastral - enum: - - Abled - - Unabled - - Cancelled - - Unknown - type: string - taxNumber: - description: Inscrição Estadual (IE) - type: string - statusOn: - format: date-time - description: Data da situação cadastral - type: string - openedOn: - format: date-time - description: Data da abertura - type: string - closedOn: - format: date-time - description: Data fim atividade - type: string - additionalInformation: - description: Informações adicionais - type: string - code: - description: Estado - enum: - - AC - - AL - - AM - - AP - - BA - - CE - - DF - - ES - - GO - - MA - - MG - - MS - - MT - - PA - - PB - - PE - - PI - - PR - - RJ - - RN - - RO - - RR - - RS - - SC - - SE - - SP - - TO - - EX - - NA - type: string - address: - $ref: '#/definitions/DataTech.Api.Resources.AddressResourceItem' - description: Endereço - economicActivities: - description: Objeto com Código e descrição das atividades econômicas principal e secundárias (CNAE) - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.EconomicActivityResource' - nfe: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Eletrônica (NFE) - nfse: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Serviço Eletrônica (NFSE) - cte: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Conhecimento de Transporte Eletrônico (CTE) - nfce: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Consumidor Eletrônica (NFCE) - DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource: - description: Informações do contribuinte - type: object - properties: - status: - description: "Status da Situação do Contribuinte\r\n AbledUnabledUnknown" - enum: - - Abled - - Unabled - - Unknown - type: string - description: - description: Descrição da fonte de dados - type: string - DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceCompleteResource: - type: object - properties: - legalEntity: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceItemResource' - DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceItemResource: - type: object - properties: - tradeName: - description: Nome fantasia - type: string - name: - description: Razão social - type: string - federalTaxNumber: - format: int64 - description: Número da inscrição na Receita Federal (CNPJ) - type: integer - createdOn: - format: date-time - description: Data de Consulta do usuário - type: string - taxRegime: - description: "Código de Regime Tributário (CRT)\r\n\r\n 0 - Desconhecido (Necessário mapear)\r\n 1 - Simples Nacional\r\n 2 - MEI\r\n 3 - Regime Normal - Lucro Presumido ou Lucro Real (Normal_Regime)\r\n" - enum: - - Unknown - - SimplesNacional - - MEI - - Normal - type: string - legalNature: - description: Código da Natureza Jurídica - 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 - - OutrasSemFimLucrativo - - Unknown - type: string - fiscalUnit: - description: Unidade de fiscalização - type: string - createdUnit: - description: Unidade de cadastro - type: string - checkCode: - description: Código de verificação - type: string - stateTaxes: - description: Inscrições estaduais - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceResource' - DataTech.Api.Resources.LegalEntities.StateTaxToIssueInvoiceResource: - description: Inscrições estaduais - type: object - properties: - status: - description: Situação cadastral - enum: - - Abled - - Unabled - - Cancelled - - UnabledTemp - - UnabledNotConfirmed - - Unknown - - UnknownTemp - - UnknownNotConfirmed - type: string - taxNumber: - description: Inscrição Estadual (IE) - type: string - statusOn: - format: date-time - description: Data da situação cadastral - type: string - openedOn: - format: date-time - description: Data da abertura - type: string - closedOn: - format: date-time - description: Data fim atividade - type: string - additionalInformation: - description: Informações adicionais - type: string - code: - description: Estado - enum: - - AC - - AL - - AM - - AP - - BA - - CE - - DF - - ES - - GO - - MA - - MG - - MS - - MT - - PA - - PB - - PE - - PI - - PR - - RJ - - RN - - RO - - RR - - RS - - SC - - SE - - SP - - TO - - EX - - NA - type: string - address: - $ref: '#/definitions/DataTech.Api.Resources.AddressResourceItem' - description: Endereço - economicActivities: - description: Objeto com Código e descrição das atividades econômicas principal e secundárias (CNAE) - type: array - items: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.EconomicActivityResource' - nfe: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Eletrônica (NFE) - nfse: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Serviço Eletrônica (NFSE) - cte: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Conhecimento de Transporte Eletrônico (CTE) - nfce: - $ref: '#/definitions/DataTech.Api.Resources.LegalEntities.FiscalDocumentDescriptionResource' - description: Indicador de Nota Fiscal de Consumidor Eletrônica (NFCE) -securityDefinitions: - 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}"' + description: 'Código da atividade (CNAE)' + format: int32 + description: + type: string + description: 'Descrição da atividade (CNAE)' + nullable: true + additionalProperties: false + description: 'Objeto com Código e descrição das atividades econômicas principal e secundárias' + EconomicActivityType: + enum: + - Main + - Secondary + type: string + FiscalDocumentDescriptionResource: + type: object + properties: + status: + $ref: '#/components/schemas/StateTaxFiscalDocumentStatus' + description: + type: string + description: 'Descrição da fonte de dados' + nullable: true + additionalProperties: false + description: 'Informações do contribuinte' + LegalEntityNatureResource: + type: object + properties: + code: + type: string + description: 'Código da Natureza Legal' + nullable: true + description: + type: string + description: 'Descrição da Natureza Legal' + nullable: true + additionalProperties: false + LegalEntitySize: + enum: + - ME + - EPP + - DEMAIS + - Unknown + type: string + LegalEntityStatus: + enum: + - Active + - Suspended + - Cancelled + - Unabled + - 'Null' + - Unknown + type: string + LegalNature: + enum: + - Unknown + - OutrasSemFimLucrativo + - 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 + LegalPersonResourceV3: + type: object + properties: + legalEntity: + $ref: '#/components/schemas/LegalPersonResourceV3Item' + additionalProperties: false + LegalPersonResourceV3Item: + type: object + properties: + tradeName: + type: string + description: 'Nome fantasia' + nullable: true + name: + type: string + description: 'Razão social' + nullable: true + federalTaxNumber: + type: string + description: 'Número da inscrição na Receita Federal (CNPJ), em texto — aceita formato alfanumérico' + nullable: true + size: + $ref: '#/components/schemas/LegalEntitySize' + openedOn: + type: string + description: 'Data da abertura' + format: date-time + nullable: true + address: + $ref: '#/components/schemas/AddressResourceItem' + phones: + type: array + items: + $ref: '#/components/schemas/PhoneResource' + description: 'Número de telefone' + nullable: true + statusOn: + type: string + description: 'Data da situação cadastral' + format: date-time + nullable: true + status: + $ref: '#/components/schemas/LegalEntityStatus' + email: + type: string + description: 'Correio eletrônico' + nullable: true + responsableEntity: + type: string + description: 'Ente Federativo Responsável (EFR)' + nullable: true + specialStatus: + type: string + description: 'Situação Especial' + nullable: true + specialStatusOn: + type: string + description: 'Data da Situação Especial' + format: date-time + nullable: true + issuedOn: + type: string + description: 'Data de Consulta do usuário' + format: date-time + nullable: true + statusReason: + type: string + description: 'Motivo da Situação Cadastral' + nullable: true + shareCapital: + type: number + description: 'Capital sócial (em reais)' + format: double + economicActivities: + type: array + items: + $ref: '#/components/schemas/EconomicActivityResource' + description: 'Objeto com Código e descrição das atividades econômicas principal e secundárias' + nullable: true + legalNature: + $ref: '#/components/schemas/LegalEntityNatureResource' + partners: + type: array + items: + $ref: '#/components/schemas/PartnerResource' + description: 'Objeto com nome e qualificação dos sócios e administradores' + nullable: true + registrationUnit: + type: string + description: 'Objeto com a cidade/unidade registradora do certificado de baixa' + nullable: true + unit: + $ref: '#/components/schemas/UnitType' + taxRegime: + $ref: '#/components/schemas/TaxRegimes' + taxRegimeHistory: + type: array + items: + $ref: '#/components/schemas/TaxRegimes' + nullable: true + additionalProperties: false + PartnerResource: + type: object + properties: + name: + type: string + description: 'Nome/Nome Empresarial' + nullable: true + qualification: + $ref: '#/components/schemas/QualificationResource' + additionalProperties: false + PhoneResource: + type: object + properties: + ddd: + type: string + description: Prefixo + nullable: true + number: + type: string + description: 'Número do telefone' + nullable: true + source: + $ref: '#/components/schemas/Sources' + additionalProperties: false + QualificationResource: + type: object + properties: + code: + type: string + description: 'Código Qualificação do Quadro de Sócios e Administradores' + nullable: true + description: + type: string + description: 'Descrição da Qualificação do Quadro de Sócios e Administradores' + nullable: true + additionalProperties: false + Sources: + enum: + - RFB + type: string + StateCode: + enum: + - NA + - RO + - AC + - AM + - RR + - PA + - AP + - TO + - MA + - PI + - CE + - RN + - PB + - PE + - AL + - SE + - BA + - MG + - ES + - RJ + - SP + - PR + - SC + - RS + - MS + - MT + - GO + - DF + - EX + type: string + StateTaxFiscalDocumentStatus: + enum: + - Abled + - Unabled + - Unknown + type: string + StateTaxNumberStatus: + enum: + - Abled + - Unabled + - Cancelled + - Unknown + type: string + StateTaxResource: + type: object + properties: + status: + $ref: '#/components/schemas/StateTaxNumberStatus' + taxNumber: + type: string + description: 'Inscrição Estadual (IE)' + nullable: true + statusOn: + type: string + description: 'Data da situação cadastral' + format: date-time + nullable: true + openedOn: + type: string + description: 'Data da abertura' + format: date-time + nullable: true + closedOn: + type: string + description: 'Data fim atividade' + format: date-time + nullable: true + additionalInformation: + type: string + description: 'Informações adicionais' + nullable: true + code: + $ref: '#/components/schemas/StateCode' + address: + $ref: '#/components/schemas/AddressResourceItem' + economicActivities: + type: array + items: + $ref: '#/components/schemas/EconomicActivityResource' + description: 'Objeto com Código e descrição das atividades econômicas principal e secundárias (CNAE)' + nullable: true + nfe: + $ref: '#/components/schemas/FiscalDocumentDescriptionResource' + nfse: + $ref: '#/components/schemas/FiscalDocumentDescriptionResource' + cte: + $ref: '#/components/schemas/FiscalDocumentDescriptionResource' + nfce: + $ref: '#/components/schemas/FiscalDocumentDescriptionResource' + additionalProperties: false + description: 'Inscrições estaduais' + StateTaxResourceItemV3: + type: object + properties: + tradeName: + type: string + description: 'Nome fantasia' + nullable: true + name: + type: string + description: 'Razão social' + nullable: true + federalTaxNumber: + type: string + description: 'Número da inscrição na Receita Federal (CNPJ), em texto — aceita formato alfanumérico' + nullable: true + createdOn: + type: string + description: 'Data de Consulta do usuário' + format: date-time + nullable: true + taxRegime: + $ref: '#/components/schemas/TaxRegimeType' + legalNature: + $ref: '#/components/schemas/LegalNature' + fiscalUnit: + type: string + description: 'Unidade de fiscalização' + nullable: true + createdUnit: + type: string + description: 'Unidade de cadastro' + nullable: true + checkCode: + type: string + description: 'Código de verificação' + nullable: true + stateTaxes: + type: array + items: + $ref: '#/components/schemas/StateTaxResource' + description: 'Inscrições estaduais' + nullable: true + additionalProperties: false + StateTaxResourceV3: + type: object + properties: + legalEntity: + $ref: '#/components/schemas/StateTaxResourceItemV3' + additionalProperties: false + TaxRegimeType: + enum: + - Unknown + - SimplesNacional + - MEI + - Normal + type: string + TaxRegimes: + type: object + properties: + regime: + type: string + nullable: true + optIn: + type: string + format: date-time + nullable: true + optOut: + type: string + format: date-time + nullable: true + additionalProperties: false + UnitType: + enum: + - Headoffice + - Subsidiary + type: string + securitySchemes: + Authorization_Header: + type: apiKey + description: 'Autenticar usando o cabeçalho HTTP' + name: Authorization + in: header + Authorization_QueryParam: + type: apiKey + description: 'Autenticar usando o parâmetro na URL' + name: apikey + in: query + Authorization_JwtBearer: + type: http + description: 'Autenticar usando o cabeçalho HTTP' + scheme: bearer + bearerFormat: 'Json Web Token' security: - - Authorization_Header: [] - Authorization_QueryParam: [] + - + Authorization_Header: { } + Authorization_QueryParam: { } + - + Authorization_JwtBearer: { } +tags: + - + name: LegalEntities diff --git a/openapi/nf-consumidor-v2.yaml b/openapi/nf-consumidor-v2.yaml index 6ee3775..6853034 100644 --- a/openapi/nf-consumidor-v2.yaml +++ b/openapi/nf-consumidor-v2.yaml @@ -4,7 +4,7 @@ info: description: "# Introducão\nSeja bem-vindo a documentação da API de Nota Fiscal de Consumidor!\nNossa API foi criada utilizando o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada abaixo.\n\n\n# Como usar a API?\nLogo a seguir você encontrará todos os recursos e metódos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\n\n\n# Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra 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" version: v2 servers: - - url: https://api.nfse.io/ + - url: https://api.nfse.io tags: - name: Companies description: | @@ -5531,12 +5531,6 @@ components: $ref: '#/components/schemas/ConsumptionCityCode' ibsConsumptionCityCode: $ref: '#/components/schemas/IbsConsumptionCityCode' - debitType: - description: "⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55)." - $ref: '#/components/schemas/DebitType' - creditType: - description: "⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55)." - $ref: '#/components/schemas/CreditType' governmentPurchase: $ref: '#/components/schemas/GovernmentPurchaseResource' buyer: @@ -7836,46 +7830,6 @@ components: description: "Valor de CBS a transferir (vCBS)." format: "double" additionalProperties: false - CreditType: - type: "string" - nullable: true - description: | - Tipo de Nota de Crédito (tpNFCredito). - Valores possíveis: - - `FinesAndInterest`: Multa e juros - - `IbsPresumedCreditAppropriationZfm`: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM - - `ReturnDeliveryRefusedOrNotFound`: Retorno por recusa na entrega ou não localização do destinatário - - `ValueReduction`: Redução de valores - - `TransferCreditSuccession`: Transferência de crédito na sucessão - enum: - - "FinesAndInterest" - - "IbsPresumedCreditAppropriationZfm" - - "ReturnDeliveryRefusedOrNotFound" - - "ValueReduction" - - "TransferCreditSuccession" - DebitType: - type: "string" - nullable: true - description: | - Tipo de Nota de Débito (tpNFDebito). - Valores possíveis: - - `TransferCreditsToCooperatives`: Transferência de créditos para cooperativas - - `CancelCreditsExemptImmuneSales`: Cancelamento de créditos por vendas isentas/imunes - - `UnprocessedInvoicesDebits`: Débitos de faturas não processadas no cálculo - - `FinesAndInterest`: Multas e juros - - `TransferInheritanceCredit`: Transferência de crédito de herança - - `AdvancePayment`: Pagamento antecipado - - `InventoryLoss`: Perda de estoque - - `SnDisqualification`: Desenquadramento do Simples Nacional - enum: - - "TransferCreditsToCooperatives" - - "CancelCreditsExemptImmuneSales" - - "UnprocessedInvoicesDebits" - - "FinesAndInterest" - - "TransferInheritanceCredit" - - "AdvancePayment" - - "InventoryLoss" - - "SnDisqualification" DefermentTaxResource: type: "object" description: "Grupo de Informações do Diferimento" diff --git a/openapi/nf-consumidor-v3.yaml b/openapi/nf-consumidor-v3.yaml new file mode 100644 index 0000000..5176c3e --- /dev/null +++ b/openapi/nf-consumidor-v3.yaml @@ -0,0 +1,4267 @@ +openapi: 3.0.1 +info: + title: Nota Fiscal de Consumidor (V3) + description: "**V3 — suporte a CNPJ alfanumérico (IN RFB 2.229/2024).** Esta versão aceita emitentes e destinatários\ + \ com CNPJ alfanumérico e retorna `federalTaxNumber` sempre como **string**. As versões V1/V2 permanecem congeladas\ + \ (somente CNPJ numérico). A chave de acesso de emitente alfanumérico usa Módulo 11 com ASCII−48 (NT Conjunta\ + \ ENCAT 2025.001) e é gerada automaticamente. Veja o [guia de migração](/docs/documentacao/nossa-plataforma/migracao-emissao-v2-para-v3/).\n\ + \n# Introducão\nSeja bem-vindo a documentação da API de Nota Fiscal de Consumidor!\nNossa API foi criada utilizando\ + \ o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender\ + \ ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada\ + \ abaixo.\n\n\n# Como usar a API?\nLogo a seguir você encontrará todos os recursos e metódos suportados pela\ + \ API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\n\n\n\ + # Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações\ + \ para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra 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" + version: v3 +servers: +- url: https://api.nfse.io +tags: +- name: Consumer Invoices + description: "Nesta sessão estão disponíveis informações necessárias para emitir uma Nota Fiscal De Consumidor\ + \ Eletrônica usando a nossa API. \n\nVocê também encontrará informações sobre consulta de uma nota fiscal por\ + \ ID, consulta de uma lista de notas por empresa, consulta do PDF do Documento Auxiliar da Nota Fiscal Eletrônica(DANFE-NFCE)\ + \ e consulta do XML da nota fiscal de consumidor eletrônica.\n" +paths: + /v3/companies/{companyId}/consumerinvoices: + get: + tags: + - Consumer Invoices + summary: Listar as Notas Fiscais Eletrônicas (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar uma lista de notas fiscais\ + \ de consumidor eletrônica por empresa." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: environment + in: query + description: Ambiente das notas (Production/Test) + schema: + $ref: '#/components/schemas/EnvironmentType' + - name: startingAfter + in: query + description: 'Id da nota fiscal de início do contador (Default: Empty)' + schema: + type: string + - name: endingBefore + in: query + description: 'Id da nota fiscal final do contador (Default: Empty)' + schema: + type: string + - name: q + in: query + description: 'Buscar por parâmetros. ("Elasticsearch string query") Ex: (q=buyer.name:''EMPRESA LTDA'')' + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + responses: + '200': + description: Sucesso na consulta em lista + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerInvoicesResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + post: + tags: + - Consumer Invoices + summary: Emitir uma Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal de Consumidor\ + \ Eletrônica (NFCE) para fila de emissão.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona,\ + \ ou seja, o retorno positivo\r\nnão garante a emissão do documento fiscal.\r\nPara obter um retorno ao\ + \ final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos\r\nutilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + requestBody: + description: Dados da nota fiscal de Consumidor a ser emitida + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerInvoiceRequest' + text/json: + schema: + $ref: '#/components/schemas/ConsumerInvoiceRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ConsumerInvoiceRequest' + responses: + '200': + description: Sucesso ao enfileirar para emissão + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerInvoiceRequest' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/consumerinvoices/{invoiceId}: + get: + tags: + - Consumer Invoices + summary: Consultar por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ de Consumidor Eletrônica (NFCE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/InvoiceResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + delete: + tags: + - Consumer Invoices + summary: Cancelar uma Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal de Consumidor\ + \ Eletrônica (NFCE) para fila de cancelamento.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona,\ + \ ou seja, o retorno positivo\r\nnão garante o cancelamento do documento fiscal.\r\nPara obter um retorno\ + \ ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os\ + \ WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor que deverá ser cancelada + required: true + schema: + type: string + - name: reason + in: query + description: Motivo do cancelamento + schema: + type: string + responses: + '204': + description: Sucesso ao enfileirar para cancelamento + content: + application/json: + schema: + $ref: '#/components/schemas/RequestCancellationResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/consumerinvoices/{invoiceId}/items: + get: + tags: + - Consumer Invoices + summary: Consultar os produtos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ de Consumidor Eletrônica (NFCE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada + required: true + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + - name: startingAfter + in: query + description: 'Índice de início do contador (Default: 0)' + schema: + type: integer + format: int32 + default: 0 + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/InvoiceItemsResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + /v3/companies/{companyId}/consumerinvoices/{invoiceId}/events: + get: + tags: + - Consumer Invoices + summary: Consultar eventos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ de Consumidor Eletrônica (NFCE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada + required: true + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + - name: startingAfter + in: query + description: 'Índice de início do contador (Default: 0)' + schema: + type: integer + format: int32 + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/InvoiceEventsResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + /v3/companies/{companyId}/consumerinvoices/{invoiceId}/pdf: + get: + tags: + - Consumer Invoices + summary: Consultar PDF do Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar a URL para o Documento\ + \ Auxiliar Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e)\r\nem formato de arquivo PDF." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor que deverá ser retornado + required: true + schema: + type: string + - name: force + in: query + schema: + type: boolean + default: false + responses: + '200': + description: Sucesso na consulta do DANFE-NFC-e + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/consumerinvoices/{invoiceId}/xml: + get: + tags: + - Consumer Invoices + summary: Consultar XML da Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma nota fiscal\ + \ de Consumidor Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFCE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/consumerinvoices/{invoiceId}/xml/rejection: + get: + tags: + - Consumer Invoices + summary: Consultar XML de rejeição da Nota Fiscal de Consumidor Eletrônica (NFCE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar o motivo da rejeição de\ + \ uma nota fiscal de Consumidor Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal de Consumidor que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFCE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal de Consumidor Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/consumerinvoices/disablement: + post: + tags: + - Consumer Invoices + summary: Inutilizar números de nota fiscal + description: "### Informações adicionais\r\nCaso seja um único número, utilizar o Número inicial e o Número\ + \ final com o mesmo valor" + parameters: + - name: companyId + in: path + description: ID da Empresa + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisablementResource' + text/json: + schema: + $ref: '#/components/schemas/DisablementResource' + application/*+json: + schema: + $ref: '#/components/schemas/DisablementResource' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/DisablementResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' +components: + schemas: + ActivityResource: + type: object + properties: + data: + description: Detalhes do Evento + nullable: true + type: + type: string + description: Nome do Evento gerado + nullable: true + sequence: + type: integer + description: Número sequencial do Evento + format: int32 + nullable: true + additionalProperties: false + AdditionResource: + type: object + properties: + code: + type: integer + description: Numero da adição (nAdicao) + format: int64 + nullable: true + manufacturer: + type: string + description: Código do fabricante estrangeiro (cFabricante) + nullable: true + amount: + type: number + description: Valor do desconto do item da DI – Adição (vDescDI) + format: double + nullable: true + drawback: + type: integer + description: Número do ato concessório de Drawback (nDraw) + format: int64 + nullable: true + additionalProperties: false + description: Adições (adi) + AdditionalInformationResource: + type: object + properties: + fisco: + type: string + description: Informações Adicionais de Interesse do Fisco (infAdFisco) + nullable: true + taxpayer: + type: string + description: Informações Complementares de interesse do Contribuinte (infCpl) + nullable: true + xmlAuthorized: + type: array + items: + type: integer + format: int64 + description: Informações Complementares de interesse do Contribuinte (infCpl) + nullable: true + effort: + type: string + nullable: true + order: + type: string + nullable: true + contract: + type: string + nullable: true + taxDocumentsReference: + type: array + items: + $ref: '#/components/schemas/TaxDocumentsReferenceResource' + description: Documentos Fiscais Referenciados (refECF) + nullable: true + advancePayment: + type: array + items: + $ref: '#/components/schemas/AdvancePaymentItemResource' + description: Grupo de notas de antecipação de pagamento - Informado para abater as parcelas de antecipação + de pagamento, conforme Art. 10. § 4º (gPagAntecipado). + nullable: true + taxpayerComments: + type: array + items: + $ref: '#/components/schemas/TaxpayerCommentsResource' + description: Observações fiscais (obsCont) + nullable: true + referencedProcess: + type: array + items: + $ref: '#/components/schemas/ReferencedProcessResource' + description: Processos referenciados (procRef) + nullable: true + additionalProperties: false + AddressResource: + type: object + properties: + state: + type: string + description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' + nullable: true + city: + $ref: '#/components/schemas/CityResource' + district: + type: string + description: Bairro do Endereço + nullable: true + additionalInformation: + type: string + description: 'Complemento do Endereço, ex.: AP 2, BL A.' + nullable: true + street: + type: string + description: Logradouro do Endereço + nullable: true + number: + type: string + description: Número do Endereço. Usar S/N para "sem número". + nullable: true + postalCode: + type: string + description: Cód. Endereço Postal (CEP) + nullable: true + country: + type: string + description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' + nullable: true + phone: + type: string + description: Telefone + nullable: true + additionalProperties: false + description: Dados do Endereço + AuthorizationResource: + type: object + properties: + receiptOn: + type: string + format: date-time + nullable: true + accessKey: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + BillResource: + type: object + properties: + number: + type: string + description: Número da Fatura (nFat) + nullable: true + originalAmount: + type: number + description: Valor Original da Fatura (vOrig) + format: double + nullable: true + discountAmount: + type: number + description: Valor do desconto (vDesc) + format: double + nullable: true + netAmount: + type: number + description: Valor Líquido da Fatura (vLiq) + format: double + nullable: true + additionalProperties: false + BillingResource: + type: object + properties: + bill: + $ref: '#/components/schemas/BillResource' + duplicates: + type: array + items: + $ref: '#/components/schemas/DuplicateResource' + description: Grupo Duplicata (dup) + nullable: true + additionalProperties: false + BuyerResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumberIndicator: + $ref: '#/components/schemas/ReceiverStateTaxIndicator' + tradeName: + type: string + description: Nome fantasia + nullable: true + taxRegime: + $ref: '#/components/schemas/TaxRegime' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de endereço do Destinatário da NF-e" + CIDEResource: + type: object + properties: + bc: + type: number + description: BC da CIDE (qBCProd) + format: double + nullable: true + rate: + type: number + description: Valor da alíquota da CIDE (vAliqProd) + format: double + nullable: true + cideAmount: + type: number + description: Valor da CIDE (vCIDE) + format: double + nullable: true + additionalProperties: false + CardResource: + type: object + properties: + federalTaxNumber: + type: string + description: CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) + nullable: true + flag: + $ref: '#/components/schemas/FlagCard' + authorization: + type: string + description: Número de autorização da operação cartão de crédito e/ou débito (cAut) + nullable: true + integrationPaymentType: + $ref: '#/components/schemas/IntegrationPaymentType' + federalTaxNumberRecipient: + type: string + description: CNPJ do beneficiário do pagamento (CNPJReceb) + nullable: true + idPaymentTerminal: + type: string + description: Identificador do terminal de pagamento (idTermPag) + nullable: true + additionalProperties: false + CityResource: + type: object + properties: + code: + type: string + description: Cód. do Município, segundo o Tabela de Municípios do IBGE + nullable: true + name: + type: string + description: Nome do Município + nullable: true + additionalProperties: false + CofinsTaxResource: + type: object + properties: + cst: + type: string + description: Código de Situação Tributária da COFINS + nullable: true + baseTax: + type: number + description: Valor da Base de Cálculo da COFINS (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota da COFINS (em percentual) (pCOFINS) + format: double + nullable: true + amount: + type: number + description: Valor da COFINS (vCOFINS) + format: double + nullable: true + baseTaxProductQuantity: + type: number + description: Quantidade Vendida (qBCProd) + format: double + nullable: true + productRate: + type: number + description: Alíquota da COFINS (em reais) (vAliqProd) + format: double + nullable: true + additionalProperties: false + description: "Grupo do COFINS\r\n\r\nID: S01\r\nPai: M01\r\n\r\n Obs: Informar apenas um dos grupos S02,\ + \ S03, S04 ou S04\r\n com base valor atribuído ao campo S06 – CST do COFINS\r\n" + ConsumerInvoiceRequest: + required: + - items + type: object + properties: + id: + type: string + description: Identificador único + nullable: true + payment: + type: array + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag) + nullable: true + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + operationOn: + type: string + description: "⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). Data e\ + \ Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato\ + \ UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + destination: + $ref: '#/components/schemas/Destination' + printType: + $ref: '#/components/schemas/PrintType' + purposeType: + $ref: '#/components/schemas/PurposeType' + consumerType: + $ref: '#/components/schemas/ConsumerType' + presenceType: + $ref: '#/components/schemas/ConsumerPresenceType' + contingencyOn: + type: string + description: "Data e Hora da entrada em contingência (dhCont)\r\n\r\n Data e hora no formato\ + \ UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD\r\n" + format: date-time + nullable: true + contingencyJustification: + type: string + description: Justificativa da entrada em contingência (xJust) + nullable: true + consumptionCityCode: + $ref: '#/components/schemas/ConsumptionCityCode' + ibsConsumptionCityCode: + $ref: '#/components/schemas/IbsConsumptionCityCode' + governmentPurchase: + $ref: '#/components/schemas/GovernmentPurchaseResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + transport: + description: '⚠️ Uso vedado na NFC-e (modelo 65): frete, transportador, veículo, reboque, vagão, balsa + e volumes são rejeitados (rejeições 753–759 do MOC). Grupo aplicável à NF-e (modelo 55).' + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + items: + type: array + items: + $ref: '#/components/schemas/InvoiceItemResource' + description: Detalhamento de Produtos e Serviços (det) + totals: + $ref: '#/components/schemas/TotalResource' + billing: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/BillingResource' + issuer: + $ref: '#/components/schemas/IssuerFromRequestResource' + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + additionalProperties: false + description: Nota Fiscal de Consumidor Eletrônica (NFCe) + ConsumerInvoicesResource: + type: object + properties: + consumerInvoices: + type: array + items: + $ref: '#/components/schemas/InvoiceWithoutEventsResource' + description: Lista de Notas Fiscais de Consumidor Eletrônicas (NFC-e) + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + additionalProperties: false + description: Notas Fiscais de Consumidor Eletrônicas (NFC-e) + ConsumerPresenceType: + enum: + - None + - Presence + - Internet + - Telephone + - Delivery + - OthersNonPresenceOperation + type: string + description: Indicador de Presença (indPres ) + ConsumerType: + enum: + - FinalConsumer + - Normal + type: string + description: Indica operação com Consumidor final (indFinal) + ContingencyDetails: + type: object + properties: + authorizer: + $ref: '#/components/schemas/StateTaxProcessingAuthorizer' + startedOn: + type: string + description: Data e hora do início da contingência + format: date-time + reason: + type: string + description: Justificativa da entrada em contingência + nullable: true + additionalProperties: false + DeliveryInformationResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: Identificação do Local de entrega (entrega) + Destination: + enum: + - None + - Internal_Operation + - Interstate_Operation + - International_Operation + type: string + description: Identificador de local de destino da operação (idDest) + DisablementResource: + type: object + properties: + environment: + $ref: '#/components/schemas/EnvironmentType' + serie: + type: integer + description: Série + format: int32 + state: + $ref: '#/components/schemas/StateCode' + beginNumber: + type: integer + description: Número inicial + format: int32 + lastNumber: + type: integer + description: Número final (usar o mesmo número inicial se for apenas um número) + format: int32 + reason: + type: string + description: Motivo da inutilização + nullable: true + additionalProperties: false + description: Dados para inutilizar números de nota fiscal + DocumentElectronicInvoiceResource: + type: object + properties: + accessKey: + type: string + description: Chave de Acesso (refNFe) + nullable: true + additionalProperties: false + DocumentInvoiceReferenceResource: + type: object + properties: + state: + type: number + description: Código da UF (cUF) + format: double + nullable: true + yearMonth: + type: string + description: Ano / Mês (AAMM) + nullable: true + federalTaxNumber: + type: string + description: CNPJ (CNPJ) + nullable: true + model: + type: string + description: Modelo (mod) + nullable: true + series: + type: string + description: Série (serie) + nullable: true + number: + type: string + description: Número (nNF) + nullable: true + additionalProperties: false + DuductionIndicator: + enum: + - NotDeduct + - Deduce + type: string + description: Indicador de intermediador/marketplace (indIntermed) + DuplicateResource: + type: object + properties: + number: + type: string + description: Número da Duplicata (nDup) + nullable: true + expirationOn: + type: string + description: Data de vencimento (dVenc) + format: date-time + nullable: true + amount: + type: number + description: Valor da duplicata (vDup) + format: double + nullable: true + additionalProperties: false + EconomicActivityResource: + type: object + properties: + type: + $ref: '#/components/schemas/EconomicActivityType' + code: + type: integer + description: Código da Atividade da Empresa + format: int32 + nullable: true + additionalProperties: false + EconomicActivityType: + enum: + - Main + - Secondary + type: string + EnvironmentType: + enum: + - None + - Production + - Test + type: string + ErrorResource: + type: object + properties: + code: + type: integer + format: int32 + nullable: true + message: + type: string + nullable: true + additionalProperties: false + ErrorsResource: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResource' + nullable: true + readOnly: true + additionalProperties: false + ExemptReason: + enum: + - Agriculture + - Others + - DevelopmentEntities + type: string + description: "Campo será preenchido quando o campo anterior estiver\r\npreenchido.Informar o motivo da desoneração:" + ExportDetailResource: + type: object + properties: + drawback: + type: string + description: Número do ato concessório de Drawback (nDraw) + nullable: true + hintInformation: + $ref: '#/components/schemas/ExportHintResource' + additionalProperties: false + ExportHintResource: + type: object + properties: + registryId: + type: string + description: Número do Registro de Exportação (nRE) + nullable: true + accessKey: + type: string + description: Chave de Acesso da NF-e recebida para exportação (chNFe) + nullable: true + quantity: + type: number + description: Quantidade do item realmente exportado (qExport) + format: double + nullable: true + additionalProperties: false + ExportResource: + type: object + properties: + state: + $ref: '#/components/schemas/StateCode' + office: + type: string + description: Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) + nullable: true + local: + type: string + description: Informações Complementares de interesse do Contribuinte (xLocDespacho) + nullable: true + additionalProperties: false + FileResource: + type: object + properties: + uri: + type: string + description: Endereço Absoluto URI para o arquivo + nullable: true + additionalProperties: false + description: Arquivo + FlagCard: + enum: + - None + - Visa + - Mastercard + - AmericanExpress + - Sorocred + - DinersClub + - Elo + - Hipercard + - Aura + - Cabal + - Alelo + - BanesCard + - CalCard + - Credz + - Discover + - GoodCard + - GreenCard + - Hiper + - JCB + - Mais + - MaxVan + - Policard + - RedeCompras + - Sodexo + - ValeCard + - Verocheque + - VR + - Ticket + - Other + type: string + FuelOriginResource: + type: object + properties: + indImport: + type: integer + description: Indicador de importação (indImport) + format: int32 + nullable: true + cUFOrig: + type: integer + description: Código da UF (cUFOrig) + format: int32 + nullable: true + pOrig: + type: number + description: Percentual originário para a UF (pOrig) + format: double + nullable: true + additionalProperties: false + FuelResource: + type: object + properties: + codeANP: + type: string + description: Código de produto da ANP (cProdANP) + nullable: true + percentageNG: + type: number + description: Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) + format: double + nullable: true + descriptionANP: + type: string + description: Descrição do produto conforme ANP (descANP) + nullable: true + percentageGLP: + type: number + description: Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) + format: double + nullable: true + percentageNGn: + type: number + description: Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) + format: double + nullable: true + percentageGNi: + type: number + description: Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) + format: double + nullable: true + startingAmount: + type: number + description: Valor de partida (cProdANP=210203001) (vPart) + format: double + nullable: true + codif: + type: string + description: Código de autorização / registro do CODIF (CODIF) + nullable: true + amountTemp: + type: number + description: Quantidade de combustível faturada à temperatura ambiente (qTemp) + format: double + nullable: true + stateBuyer: + type: string + description: Sigla da UF de consumo (UFCons) + nullable: true + cide: + $ref: '#/components/schemas/CIDEResource' + pump: + $ref: '#/components/schemas/PumpResource' + fuelOrigin: + $ref: '#/components/schemas/FuelOriginResource' + additionalProperties: false + ICMSTotalResource: + type: object + properties: + baseTax: + type: number + description: Base de Cálculo do ICMS (vBC) + format: double + nullable: true + icmsAmount: + type: number + description: Valor Total do ICMS (vICMS) + format: double + nullable: true + icmsExemptAmount: + type: number + description: Valor ICMS Total desonerado (vICMSDeson) + format: double + nullable: true + stCalculationBasisAmount: + type: number + description: Base de Cálculo do ICMS Substituição Tributária (vBCST) + format: double + nullable: true + stAmount: + type: number + description: Valor Total do ICMS ST (vST) + format: double + nullable: true + productAmount: + type: number + description: Valor Total dos produtos e serviços (vProd) + format: double + nullable: true + freightAmount: + type: number + description: Valor Total do Frete (vFrete) + format: double + nullable: true + insuranceAmount: + type: number + description: Valor Total do Seguro (vSeg) + format: double + nullable: true + discountAmount: + type: number + description: Valor Total do Desconto (vDesc) + format: double + nullable: true + iiAmount: + type: number + description: Valor Total do Imposto de Importação (vII) + format: double + nullable: true + ipiAmount: + type: number + description: Valor Total do IPI (vIPI) + format: double + nullable: true + pisAmount: + type: number + description: Valor do PIS (vPIS) + format: double + nullable: true + cofinsAmount: + type: number + description: Valor do COFINS (vCOFINS) + format: double + nullable: true + othersAmount: + type: number + description: Outras Despesas acessórias (vOutro) + format: double + nullable: true + invoiceAmount: + type: number + description: Valor Total da NF-e (vNF) + format: double + nullable: true + fcpufDestinationAmount: + type: number + description: Valor Total ICMS FCP UF Destino (vFCPUFDest) + format: double + nullable: true + icmsufDestinationAmount: + type: number + description: Valor Total ICMS Interestadual UF Destino (vICMSUFDest) + format: double + nullable: true + icmsufSenderAmount: + type: number + description: Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) + format: double + nullable: true + federalTaxesAmount: + type: number + description: Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) + format: double + nullable: true + fcpAmount: + type: number + description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + format: double + nullable: true + fcpstAmount: + type: number + description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (vFCPST) + format: double + nullable: true + fcpstRetAmount: + type: number + description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + format: double + nullable: true + ipiDevolAmount: + type: number + description: Valor total do IPI devolvido (vIPIDevol) + format: double + nullable: true + qBCMono: + type: number + description: Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) + format: double + nullable: true + vICMSMono: + type: number + description: Valor total do ICMS monofásico próprio (vICMSMono) + format: double + nullable: true + qBCMonoReten: + type: number + description: Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) + format: double + nullable: true + vICMSMonoReten: + type: number + description: Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) + format: double + nullable: true + qBCMonoRet: + type: number + description: Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) + format: double + nullable: true + vICMSMonoRet: + type: number + description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + format: double + nullable: true + additionalProperties: false + description: "Manual Contribuinte v_5.00\r\nGrupo de Valores Totais referentes ao ICMS" + ICMSUFDestinationTaxResource: + type: object + properties: + vBCUFDest: + type: number + description: Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) + format: double + nullable: true + pFCPUFDest: + type: number + description: Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de + Combate à Pobreza (FCP) naquela UF (pFCPUFDest) + format: double + nullable: true + pICMSUFDest: + type: number + description: Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) + format: double + nullable: true + pICMSInter: + type: number + description: Alíquota interestadual das UF envolvidas (pICMSInter) + format: double + nullable: true + pICMSInterPart: + type: number + description: Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) + format: double + nullable: true + vFCPUFDest: + type: number + description: Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest + format: double + nullable: true + vICMSUFDest: + type: number + description: Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) + format: double + nullable: true + vICMSUFRemet: + type: number + description: Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) + format: double + nullable: true + vBCFCPUFDest: + type: number + description: Valor da BC FCP na UF de destino (vBCFCPUFDest) + format: double + nullable: true + additionalProperties: false + description: Grupo de Tributação do ICMS de Destino da UF + IITaxResource: + type: object + properties: + baseTax: + type: string + description: Valor BC do Imposto de Importação (vBC) + nullable: true + customsExpenditureAmount: + type: string + description: Valor despesas aduaneiras (vDespAdu) + nullable: true + amount: + type: number + description: Valor Imposto de Importação (vII) + format: double + nullable: true + iofAmount: + type: number + description: Valor Imposto sobre Operações Financeiras (vIOF) + format: double + nullable: true + vEnqCamb: + type: number + description: Valor dos encargos cambiais + format: double + nullable: true + additionalProperties: false + description: "Grupo do Imposto de Importação\r\n\r\nId: P01\r\nPai: O01" + IPITaxResource: + type: object + properties: + cst: + type: string + description: Código da situação tributária do IPI (CST) + nullable: true + classificationCode: + type: string + description: Código de Enquadramento Legal do IPI (cEnq) + nullable: true + classification: + type: string + description: "clEnq\r\nClasse de enquadramento do IPI para Cigarros e Bebidas (clEnq)" + nullable: true + producerCNPJ: + type: string + description: CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação + direta ou indireta (CNPJProd) + nullable: true + stampCode: + type: string + description: Código do selo de controle IPI (cSelo) + nullable: true + stampQuantity: + type: number + description: Quantidade de selo de controle (qSelo) + format: double + nullable: true + base: + type: number + description: Valor da BC do IPI (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota do IPI (pIPI) + format: double + nullable: true + unitQuantity: + type: number + description: Quantidade total na unidade padrão para tributação (somente para os produtos tributados por + unidade) (qUnid) + format: double + nullable: true + unitAmount: + type: number + description: Valor por Unidade Tributável (vUnid) + format: double + nullable: true + amount: + type: number + description: Valor IPI (vIPI) + format: double + nullable: true + additionalProperties: false + description: "\r\nGrupo do IPI\r\n\r\nInformar apenas quando o item for sujeito ao IPI\r\n\r\nID: O01\r\n\r\ + \nPai: M01" + ISSQNTotalResource: + type: object + properties: + totalServiceNotTaxedICMS: + type: number + description: Valor Total Serv.Não Tributados p/ ICMS (vServ) + format: double + nullable: true + baseRateISS: + type: number + description: Base de Cálculo do ISS (vBC) + format: double + nullable: true + totalISS: + type: number + description: Valor Total do ISS (vISS) + format: double + nullable: true + valueServicePIS: + type: number + description: Valor do PIS sobre Serviços (vPIS) + format: double + nullable: true + valueServiceCOFINS: + type: number + description: Valor da COFINS sobre Serviços (vCOFINS) + format: double + nullable: true + provisionService: + type: string + description: Data Prestação Serviço (dCompet) + format: date-time + nullable: true + deductionReductionBC: + type: number + description: Valor Dedução para Redução da BC (vDeducao) + format: double + nullable: true + valueOtherRetention: + type: number + description: Valor Outras Retenções (vOutro) + format: double + nullable: true + discountUnconditional: + type: number + description: Valor Desconto Incondicionado (vDescIncond) + format: double + nullable: true + discountConditioning: + type: number + description: Valor Desconto Condicionado (vDescCond) + format: double + nullable: true + totalRetentionISS: + type: number + description: Valor Total Retenção ISS (vISSRet) + format: double + nullable: true + codeTaxRegime: + type: number + description: Código Regime Tributação (cRegTrib) + format: double + nullable: true + additionalProperties: false + IcmsTaxResource: + type: object + properties: + origin: + type: string + description: Origem da mercadoria (orig) + nullable: true + cst: + type: string + description: Tributação do ICMS (CST) + nullable: true + csosn: + type: string + description: "101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN)\r\nCódigo\ + \ de Situação da Operação – Simples Nacional" + nullable: true + baseTaxModality: + type: string + description: "Modalidade de determinação da BC do ICMS (modBC)\r\n\r\n Margem Valor Agregado\ + \ (%) = 0\r\n Pauta (valor) = 1\r\n Preço Tabelado Máximo (valor) = 2\r\n Valor da Operação\ + \ = 3\r\n" + nullable: true + baseTax: + type: number + description: Valor da BC do ICMS (vBC) + format: double + nullable: true + baseTaxSTModality: + type: string + description: Modalidade de determinação da BC do ICMS ST (modBCST) + nullable: true + baseTaxSTReduction: + type: string + description: "pRedBCST\r\nPercentual da Redução de BC do ICMS ST (pRedBCST)" + nullable: true + baseTaxST: + type: number + description: Valor da BC do ICMS ST (vBCST) + format: double + nullable: true + baseTaxReduction: + type: number + description: Percentual da Redução de BC (pRedBC) + format: double + nullable: true + stRate: + type: number + description: Alíquota do imposto do ICMS ST (pICMSST) + format: double + nullable: true + stAmount: + type: number + description: Valor do ICMS ST (vICMSST) + format: double + nullable: true + stMarginAmount: + type: number + description: "pMVAST\r\nPercentual da margem de valor Adicionado do ICMS ST (pMVAST)" + format: double + nullable: true + rate: + type: number + description: "pICMS\r\nAlíquota do imposto (pICMS)" + format: double + nullable: true + amount: + type: number + description: "Valor do ICMS (vICMS)\r\nO valor do ICMS desonerado será informado apenas nas operações:\r\ + \na) com produtos beneficiados com a desoneração condicional do ICMS.\r\nb) destinadas à SUFRAMA, informando-se\ + \ o valor que seria devido se não houvesse isenção.\r\nc) de venda a órgãos da administração pública\ + \ direta e suas fundações e\r\nautarquias com isenção do ICMS. (NT 2011/004)" + format: double + nullable: true + percentual: + type: number + description: Percentual da Redução de BC (pICMS) + format: double + nullable: true + snCreditRate: + type: number + description: Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) + format: double + nullable: true + snCreditAmount: + type: number + description: Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional + (vCredICMSSN) + format: double + nullable: true + stMarginAddedAmount: + type: string + description: Percentual da margem de valor Adicionado do ICMS ST (pMVAST) + nullable: true + stRetentionAmount: + type: string + description: Valor do ICMS ST retido (vICMSSTRet) + nullable: true + baseSTRetentionAmount: + type: string + description: Valor da BC do ICMS ST retido (vBCSTRet) + nullable: true + baseTaxOperationPercentual: + type: string + description: "Percentual da BC operação própria (pBCOp)\r\nPercentual para determinação do valor da\ + \ Base de Cálculo da operação própria. (v2.0)" + nullable: true + ufst: + type: string + description: "UF para qual é devido o ICMS ST (UFST)\r\nSigla da UF para qual é devido o ICMS ST da operação.\ + \ (v2.0)" + nullable: true + amountSTReason: + type: string + description: Motivo Desoneração ICMS + nullable: true + baseSNRetentionAmount: + type: string + description: Valor da BC do ICMS ST retido (vBCSTRet) + nullable: true + snRetentionAmount: + type: string + description: Valor do ICMS ST retido (vICMSSTRet) + nullable: true + amountOperation: + type: string + description: Valor do ICMS da Operação (vICMSOp) + nullable: true + percentualDeferment: + type: string + description: Percentual do Diferimento (pDif) + nullable: true + baseDeferred: + type: string + description: Valor do ICMS Diferido (vICMSDif) + nullable: true + exemptAmount: + type: number + description: Valor ICMS Desonerado + format: double + nullable: true + exemptReason: + $ref: '#/components/schemas/ExemptReason' + exemptAmountST: + type: number + description: Valor ICMS Desonerado + format: double + nullable: true + exemptReasonST: + $ref: '#/components/schemas/ExemptReason' + fcpRate: + type: number + description: Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) + format: double + nullable: true + fcpAmount: + type: number + description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + format: double + nullable: true + fcpstRate: + type: number + description: Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (pFCPST) + format: double + nullable: true + fcpstAmount: + type: number + description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (vFCPST) + format: double + nullable: true + fcpstRetRate: + type: number + description: Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) + format: double + nullable: true + fcpstRetAmount: + type: number + description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + format: double + nullable: true + baseTaxFCPSTAmount: + type: number + description: Informar o valor da Base de Cálculo do FCP (vBCFCPST) + format: double + nullable: true + substituteAmount: + type: number + description: 'Valor do ICMS próprio do Substituto (tag: vICMSSubstituto)' + format: double + nullable: true + stFinalConsumerRate: + type: number + description: "N26a - Alíquota suportada pelo Consumidor Final (pST)\r\nDeve ser informada a alíquota do\ + \ cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria" + format: double + nullable: true + effectiveBaseTaxReductionRate: + type: number + description: N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime + comum de tributação (pRedBCEfet) + format: double + nullable: true + effectiveBaseTaxAmount: + type: number + description: N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação + (vBCEfet) + format: double + nullable: true + effectiveRate: + type: number + description: N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) + format: double + nullable: true + effectiveAmount: + type: number + description: N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) + format: double + nullable: true + deductionIndicator: + $ref: '#/components/schemas/DuductionIndicator' + basisBenefitCode: + type: string + description: Código de Benefício na UF para Redução da Base de Cálculo (cBenefRBC). Tamanho 8 ou 10, quando + exigido pela UF (NT 2019.001). + nullable: true + additionalProperties: false + description: "Grupo do ICMS da Operação própria e ST\r\n\r\nID: N01\r\nPAI: M01\r\n\r\n Obs: Informar apenas\ + \ um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10,\r\n N10a, N10b, N10c, N10d, N10e, N10f,\ + \ N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0)\r\n" + ImportDeclarationResource: + type: object + properties: + code: + type: string + description: Número do Documento de Importação da DI/DSI/DA (nDI) + nullable: true + registeredOn: + type: string + description: Data de Registro da DI/DSI/DA (dDI) + format: date-time + nullable: true + customsClearanceName: + type: string + description: Local de desembaraço (xLocDesemb) + nullable: true + customsClearanceState: + $ref: '#/components/schemas/StateCode' + customsClearancedOn: + type: string + description: Data do Desembaraço Aduaneiro (dDesemb) + format: date-time + nullable: true + additions: + type: array + items: + $ref: '#/components/schemas/AdditionResource' + description: Adições (adi) + nullable: true + exporter: + type: string + description: Código do exportador (cExportador) + nullable: true + internationalTransport: + $ref: '#/components/schemas/InternationalTransportType' + intermediation: + $ref: '#/components/schemas/IntermediationType' + acquirerFederalTaxNumber: + type: string + description: CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) + nullable: true + stateThird: + type: string + description: Sigla da UF do adquirente ou do encomendante (UFTerceiro) + nullable: true + afrmmAmount: + type: number + description: Valor Adicional ao frete para renovação de marinha mercante (vAFRMM) + format: double + nullable: true + additionalProperties: false + description: Declaração Importação (DI) + IntegrationPaymentType: + enum: + - Integrated + - NotIntegrated + type: string + description: "1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio\ + \ Eletrônico)\r\n2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS);" + IntermediateResource: + type: object + properties: + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + identifier: + type: string + description: Identificador cadastrado no intermediador (idCadIntTran) + nullable: true + additionalProperties: false + description: Grupo de Informações do Intermediador da Transação (infIntermed) + IntermediationType: + enum: + - None + - ByOwn + - ImportOnBehalf + - ByOrder + type: string + description: Tipo de Intermediação + InternationalTransportType: + enum: + - None + - Maritime + - River + - Lake + - Airline + - Postal + - Railway + - Highway + - Network + - Own + - Ficta + - Courier + - Handcarry + type: string + description: Tipo Transporte Internacional + InvoiceEventsResource: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/ActivityResource' + description: Lista de Eventos ocorridos na Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + nullable: true + id: + type: string + description: Identificação + nullable: true + accountId: + type: string + description: Identificador da Conta + nullable: true + companyId: + type: string + description: Identificador da Empresa + nullable: true + additionalProperties: false + InvoiceEventsResourceBase: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/ActivityResource' + description: Lista de Eventos ocorridos na Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + nullable: true + additionalProperties: false + InvoiceItemResource: + type: object + properties: + code: + type: string + description: Código do produto ou serviço (cProd) + nullable: true + codeGTIN: + type: string + description: "GTIN (Global Trade Item Number) do produto,\r\nantigo código EAN ou código de barras (cEAN)" + nullable: true + description: + type: string + description: Descrição do produto ou serviço (xProd) + nullable: true + ncm: + type: string + description: Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) + nullable: true + nve: + type: array + items: + type: string + description: Nomenclatura de Valor aduaneiro e Estatístico (NVE) + nullable: true + extipi: + type: string + description: Código Exceção da Tabela de IPI + nullable: true + cfop: + type: integer + description: Código Fiscal de Operações e Prestações (CFOP) + format: int64 + nullable: true + unit: + type: string + description: Unidade Comercial (uCom) + nullable: true + quantity: + type: number + description: Quantidade Comercial (qCom) + format: double + nullable: true + unitAmount: + type: number + description: Valor Unitário de Comercialização (vUnCom) + format: double + nullable: true + totalAmount: + type: number + description: Valor Total Bruto dos Produtos ou Serviços (vProd) + format: double + nullable: true + codeTaxGTIN: + type: string + description: "GTIN (Global Trade Item Number) da unidade tributável,\r\nantigo código EAN ou código de\ + \ barras (cEANTrib)" + nullable: true + unitTax: + type: string + description: Unidade Tributável (uTrib) + nullable: true + quantityTax: + type: number + description: Quantidade Tributável (qTrib) + format: double + nullable: true + taxUnitAmount: + type: number + description: Valor Unitário de tributação (vUnTrib) + format: double + nullable: true + freightAmount: + type: number + description: Valor Total do Frete (vFrete) + format: double + nullable: true + insuranceAmount: + type: number + description: Valor Total do Seguro (vSeg) + format: double + nullable: true + discountAmount: + type: number + description: Valor do Desconto (vDesc) + format: double + nullable: true + othersAmount: + type: number + description: Outras despesas acessórias (vOutro) + format: double + nullable: true + totalIndicator: + type: boolean + description: "Indica se valor do Item (vProd)\r\nentra no valor total da NF-e (vProd) (indTot)" + nullable: true + cest: + type: string + description: CEST - Código especificador da substituição tributária + nullable: true + tax: + $ref: '#/components/schemas/InvoiceItemTaxResource' + additionalInformation: + type: string + description: Informações Adicionais do Produto (infAdProd) + nullable: true + numberOrderBuy: + type: string + description: Número do pedido de compra (xPed) + nullable: true + itemNumberOrderBuy: + type: integer + description: Item do Pedido de Compra (nItemPed) + format: int32 + nullable: true + importControlSheetNumber: + type: string + description: Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) + nullable: true + fuelDetail: + $ref: '#/components/schemas/FuelResource' + benefit: + type: string + description: Código de Benefício Fiscal na UF aplicado ao item (cBenef) + nullable: true + importDeclarations: + type: array + items: + $ref: '#/components/schemas/ImportDeclarationResource' + description: '⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). Declaração + Importação (DI). Observação: o grupo de tributo II não é aceito na NFC-e (rejeição 743).' + nullable: true + exportDetails: + type: array + items: + $ref: '#/components/schemas/ExportDetailResource' + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). Grupo de + informações de exportação para o item (detExport) + nullable: true + usedMovableAssetIndicator: + $ref: '#/components/schemas/UsedMovableAssetIndicator' + itemAmount: + type: number + description: Valor total do item (vItem). + format: double + nullable: true + vehicleDetail: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/VehicleDetailResource' + presumedCredit: + $ref: '#/components/schemas/PresumedCreditResource' + ibsZfmPresumedCreditClassification: + $ref: '#/components/schemas/IbsZfmPresumedCreditClassification' + referencedDFe: + $ref: '#/components/schemas/ReferencedDFeResource' + taxDetermination: + $ref: '#/components/schemas/TaxDeterminationResource' + additionalProperties: false + description: "Manual Contribuinte v_5.00\r\nGrupo do detalhamento de Produtos e Serviços da NF-e" + InvoiceItemTaxResource: + type: object + properties: + totalTax: + type: number + description: Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) + format: double + nullable: true + icms: + $ref: '#/components/schemas/IcmsTaxResource' + ipi: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/IPITaxResource' + ii: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/IITaxResource' + pis: + $ref: '#/components/schemas/PISTaxResource' + cofins: + $ref: '#/components/schemas/CofinsTaxResource' + icmsDestination: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/ICMSUFDestinationTaxResource' + IS: + $ref: '#/components/schemas/ISTaxResource' + IBSCBS: + $ref: '#/components/schemas/IBSCBSTaxResource' + competenceAdjustment: + $ref: '#/components/schemas/CompetenceAdjustmentResource' + additionalProperties: false + InvoiceItemsResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + companyId: + type: string + description: Identificador da Empresa + nullable: true + id: + type: string + description: Identificador da Nota Fiscal + nullable: true + items: + type: array + items: + $ref: '#/components/schemas/InvoiceItemResource' + description: Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identifica se existem mais items a serem consultados + nullable: true + additionalProperties: false + InvoiceResource: + type: object + properties: + id: + type: string + description: Identificador único + nullable: true + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + status: + $ref: '#/components/schemas/InvoiceStatus' + authorization: + $ref: '#/components/schemas/AuthorizationResource' + contingencyDetails: + $ref: '#/components/schemas/ContingencyDetails' + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + createdOn: + type: string + description: Data de criação + format: date-time + nullable: true + modifiedOn: + type: string + description: Data de modificação + format: date-time + nullable: true + operationOn: + type: string + description: "⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). Data e\ + \ Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato\ + \ UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + environmentType: + $ref: '#/components/schemas/EnvironmentType' + purposeType: + $ref: '#/components/schemas/PurposeType' + issuer: + $ref: '#/components/schemas/IssuerResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + totals: + $ref: '#/components/schemas/TotalResource' + transport: + description: '⚠️ Uso vedado na NFC-e (modelo 65): frete, transportador, veículo, reboque, vagão, balsa + e volumes são rejeitados (rejeições 753–759 do MOC). Grupo aplicável à NF-e (modelo 55).' + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + export: + $ref: '#/components/schemas/ExportResource' + billing: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/BillingResource' + payment: + type: array + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag) + nullable: true + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + delivery: + $ref: '#/components/schemas/DeliveryInformationResource' + withdrawal: + $ref: '#/components/schemas/WithdrawalInformationResource' + lastEvents: + $ref: '#/components/schemas/InvoiceEventsResourceBase' + additionalProperties: false + InvoiceStatus: + enum: + - None + - Created + - Processing + - Issued + - IssuedContingency + - Cancelled + - Disabled + - IssueDenied + - Error + type: string + InvoiceWithoutEventsResource: + type: object + properties: + id: + type: string + description: Identificador único + nullable: true + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + status: + $ref: '#/components/schemas/InvoiceStatus' + authorization: + $ref: '#/components/schemas/AuthorizationResource' + contingencyDetails: + $ref: '#/components/schemas/ContingencyDetails' + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + createdOn: + type: string + description: Data de criação + format: date-time + nullable: true + modifiedOn: + type: string + description: Data de modificação + format: date-time + nullable: true + operationOn: + type: string + description: "⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). Data e\ + \ Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n Data e hora no formato\ + \ UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + environmentType: + $ref: '#/components/schemas/EnvironmentType' + purposeType: + $ref: '#/components/schemas/PurposeType' + issuer: + $ref: '#/components/schemas/IssuerResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + totals: + $ref: '#/components/schemas/TotalResource' + transport: + description: '⚠️ Uso vedado na NFC-e (modelo 65): frete, transportador, veículo, reboque, vagão, balsa + e volumes são rejeitados (rejeições 753–759 do MOC). Grupo aplicável à NF-e (modelo 55).' + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + export: + $ref: '#/components/schemas/ExportResource' + billing: + description: ⚠️ Não se aplica à NFC-e (modelo 65) — campo/grupo exclusivo da NF-e (modelo 55). + $ref: '#/components/schemas/BillingResource' + payment: + type: array + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag) + nullable: true + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + delivery: + $ref: '#/components/schemas/DeliveryInformationResource' + withdrawal: + $ref: '#/components/schemas/WithdrawalInformationResource' + additionalProperties: false + IssuerFromRequestResource: + type: object + properties: + stStateTaxNumber: + type: string + description: IE do Substituto Tributário (IEST) + nullable: true + additionalProperties: false + IssuerResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + tradeName: + type: string + description: Nome Fantasia + nullable: true + openningDate: + type: string + description: Data abertura da empresa + format: date-time + nullable: true + taxRegime: + $ref: '#/components/schemas/TaxRegime' + specialTaxRegime: + $ref: '#/components/schemas/SpecialTaxRegime' + legalNature: + $ref: '#/components/schemas/LegalNature' + economicActivities: + type: array + items: + $ref: '#/components/schemas/EconomicActivityResource' + description: Atividades da Empresa (CNAE) + nullable: true + companyRegistryNumber: + type: integer + description: Número de Inscrição na Junta Comercial + format: int64 + nullable: true + regionalTaxNumber: + type: integer + description: Número de Inscrição na SEFAZ (IE) + format: int64 + nullable: true + regionalSTTaxNumber: + type: integer + description: Inscrição Estadual do Substituto Tributário (IEST) + format: int64 + nullable: true + municipalTaxNumber: + type: string + description: Número de Inscrição na Prefeitura (IM/CCM) + nullable: true + stStateTaxNumber: + type: string + description: IE do Substituto Tributário (IEST) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de identificação do emitente da NF-e" + LegalNature: + enum: + - EmpresaPublica + - SociedadeEconomiaMista + - SociedadeAnonimaAberta + - SociedadeAnonimaFechada + - SociedadeEmpresariaLimitada + - SociedadeEmpresariaEmNomeColetivo + - SociedadeEmpresariaEmComanditaSimples + - SociedadeEmpresariaEmComanditaporAcoes + - SociedadeemContaParticipacao + - Empresario + - Cooperativa + - ConsorcioSociedades + - GrupoSociedades + - EmpresaDomiciliadaExterior + - ClubeFundoInvestimento + - SociedadeSimplesPura + - SociedadeSimplesLimitada + - SociedadeSimplesEmNomeColetivo + - SociedadeSimplesEmComanditaSimples + - EmpresaBinacional + - ConsorcioEmpregadores + - ConsorcioSimples + - EireliNaturezaEmpresaria + - EireliNaturezaSimples + - ServicoNotarial + - FundacaoPrivada + - ServicoSocialAutonomo + - CondominioEdilicio + - ComissaoConciliacaoPrevia + - EntidadeMediacaoArbitragem + - PartidoPolitico + - EntidadeSindical + - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras + - FundacaoAssociacaoDomiciliadaExterior + - OrganizacaoReligiosa + - ComunidadeIndigena + - FundoPrivado + - AssociacaoPrivada + type: string + OperationType: + enum: + - Outgoing + - Incoming + type: string + PISTaxResource: + type: object + properties: + cst: + type: string + description: Código de Situação Tributária do PIS (CST) + nullable: true + baseTax: + type: number + description: Valor da Base de Cálculo do PIS (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota do PIS (em percentual) (pPIS) + format: double + nullable: true + amount: + type: number + description: Valor do PIS (vPIS) + format: double + nullable: true + baseTaxProductQuantity: + type: number + description: Quantidade Vendida (qBCProd) + format: double + nullable: true + productRate: + type: number + description: Alíquota do PIS (em reais) (vAliqProd) + format: double + nullable: true + additionalProperties: false + description: Grupo do PIS + PaymentDetailResource: + type: object + properties: + method: + $ref: '#/components/schemas/PaymentMethod' + methodDescription: + type: string + description: Descrição do meio de pagamento (xPag) + nullable: true + paymentType: + $ref: '#/components/schemas/PaymentType' + amount: + type: number + description: Valor do Pagamento (vPag) + format: double + nullable: true + card: + $ref: '#/components/schemas/CardResource' + paymentDate: + type: string + description: Data do pagamento (dPag) + format: date-time + nullable: true + federalTaxNumberPag: + type: string + description: CNPJ transacional do pagamento (CNPJPag) + nullable: true + statePag: + type: string + description: UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) + nullable: true + additionalProperties: false + PaymentMethod: + enum: + - Cash + - Cheque + - CreditCard + - DebitCard + - StoreCredict + - FoodVouchers + - MealVouchers + - GiftVouchers + - FuelVouchers + - BankBill + - BankDeposit + - InstantPayment + - WireTransfer + - Cashback + - StaticInstantPayment + - StoreCredit + - ElectronicPaymentNotInformed + - WithoutPayment + - Others + type: string + PaymentResource: + type: object + properties: + paymentDetail: + type: array + items: + $ref: '#/components/schemas/PaymentDetailResource' + description: "YA01a - Grupo Detalhamento da Forma de Pagamento (detPag)\r\nVERSÃO 4.00" + nullable: true + payBack: + type: number + description: "Valor do troco (vTroco)\r\nVERSÃO 4.00" + format: double + nullable: true + additionalProperties: false + PaymentType: + enum: + - InCash + - Term + type: string + PersonType: + enum: + - Undefined + - NaturalPerson + - LegalEntity + - Company + - Customer + type: string + PrintType: + enum: + - None + - NFeNormalPortrait + - NFeNormalLandscape + - NFeSimplified + - DANFE_NFC_E + - DANFE_NFC_E_MSG_ELETRONICA + type: string + PumpResource: + type: object + properties: + spoutNumber: + type: integer + description: Número de identificação do bico utilizado no abastecimento (nBico) + format: int32 + nullable: true + number: + type: integer + description: Número de identificação da bomba ao qual o bico está interligado (nBomba) + format: int32 + nullable: true + tankNumber: + type: integer + description: Número de identificação do tanque ao qual o bico está interligado (nTanque) + format: int32 + nullable: true + beginningAmount: + type: number + description: Valor do Encerrante no início do abastecimento (vEncIni) + format: double + nullable: true + endAmount: + type: number + description: Valor do Encerrante no final do abastecimento (vEncFin) + format: double + nullable: true + percentageBio: + type: number + description: Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão + regulamentador + format: double + nullable: true + additionalProperties: false + PurposeType: + enum: + - None + - Normal + - Complement + - Adjustment + - Devolution + type: string + ReboqueResource: + type: object + properties: + plate: + type: string + description: Placa do Veiculo (placa) + nullable: true + uf: + type: string + description: UF Veiculo Reboque (UF) + nullable: true + rntc: + type: string + description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) + nullable: true + wagon: + type: string + description: Identificação do Vagão (vagao) + nullable: true + ferry: + type: string + description: Identificação da Balsa (balsa) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Reboque" + ReceiverStateTaxIndicator: + enum: + - None + - TaxPayer + - Exempt + - NonTaxPayer + type: string + ReferencedProcessResource: + type: object + properties: + identifierConcessory: + type: string + nullable: true + identifierOrigin: + type: integer + format: int32 + nullable: true + concessionActType: + type: integer + format: int32 + nullable: true + additionalProperties: false + RequestCancellationResource: + type: object + properties: + accountId: + type: string + nullable: true + companyId: + type: string + nullable: true + productInvoiceId: + type: string + nullable: true + reason: + type: string + nullable: true + additionalProperties: false + ShippingModality: + enum: + - ByIssuer + - ByReceiver + - ByThirdParties + - OwnBySender + - OwnByBuyer + - Free + type: string + SpecialTaxRegime: + enum: + - Nenhum + - MicroempresaMunicipal + - Estimativa + - SociedadeDeProfissionais + - Cooperativa + - MicroempreendedorIndividual + - MicroempresarioEmpresaPequenoPorte + - Automatico + type: string + description: Regime especial de tributação + StateCode: + enum: + - NA + - RO + - AC + - AM + - RR + - PA + - AP + - TO + - MA + - PI + - CE + - RN + - PB + - PE + - AL + - SE + - BA + - MG + - ES + - RJ + - SP + - PR + - SC + - RS + - MS + - MT + - GO + - DF + - EX + type: string + StateTaxProcessingAuthorizer: + enum: + - Normal + - EPEC + type: string + TaxCouponInformationResource: + type: object + properties: + modelDocumentFiscal: + type: string + description: Modelo de Documento Fiscal (mod) + nullable: true + orderECF: + type: string + description: Número de Ordem Sequencial do ECF (nECF) + nullable: true + orderCountOperation: + type: integer + description: Número do Contador de Ordem de Operação (nCOO) + format: int32 + nullable: true + additionalProperties: false + TaxDeterminationResource: + type: object + properties: + operationCode: + type: integer + description: Código interno para determinação de natureza de operação + format: int32 + nullable: true + issuerTaxProfile: + type: string + description: Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos + nullable: true + buyerTaxProfile: + type: string + description: Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos + nullable: true + origin: + type: string + description: Origem da mercadoria + nullable: true + acquisitionPurpose: + type: string + description: Finalidade de aquisição - usado para o cálculo automático de impostos + nullable: true + additionalProperties: false + TaxDocumentsReferenceResource: + type: object + properties: + taxCouponInformation: + $ref: '#/components/schemas/TaxCouponInformationResource' + documentInvoiceReference: + $ref: '#/components/schemas/DocumentInvoiceReferenceResource' + documentElectronicInvoice: + $ref: '#/components/schemas/DocumentElectronicInvoiceResource' + additionalProperties: false + TaxRegime: + enum: + - None + - LucroReal + - LucroPresumido + - SimplesNacional + - SimplesNacionalExcessoSublimite + - MicroempreendedorIndividual + - Isento + type: string + description: Regime de tributação + TaxpayerCommentsResource: + type: object + properties: + field: + type: string + description: Campo (xCampo) + nullable: true + text: + type: string + description: Texto (xTexto) + nullable: true + additionalProperties: false + TotalResource: + type: object + properties: + icms: + $ref: '#/components/schemas/ICMSTotalResource' + issqn: + $ref: '#/components/schemas/ISSQNTotalResource' + withheldTaxes: + $ref: '#/components/schemas/TotalsWithholdings' + isTotals: + $ref: '#/components/schemas/ISTotalsResource' + ibsCbsTotals: + $ref: '#/components/schemas/IBSCBSTotalsResource' + totalInvoiceAmount: + type: number + description: Valor total da NF-e/NFC-e com IBS / CBS / IS (vNFTot) + format: double + nullable: true + additionalProperties: false + TransportGroupResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual do Transportador (IE) + nullable: true + transportRetention: + type: string + description: Grupo de Retenção do ICMS do transporte + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Transportador" + TransportInformationResource: + type: object + properties: + freightModality: + $ref: '#/components/schemas/ShippingModality' + transportGroup: + $ref: '#/components/schemas/TransportGroupResource' + reboque: + $ref: '#/components/schemas/ReboqueResource' + volume: + $ref: '#/components/schemas/VolumeResource' + transportVehicle: + $ref: '#/components/schemas/TransportVehicleResource' + sealNumber: + type: string + description: Número dos Lacres + nullable: true + transpRate: + $ref: '#/components/schemas/TransportRateResource' + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de Informações do Transporte da NF-e\r\nId:\ + \ X01 Pai: A1" + TransportRateResource: + type: object + properties: + serviceAmount: + type: number + description: Valor do Serviço (vServ) + format: double + nullable: true + bcRetentionAmount: + type: number + description: BC da Retenção do ICMS (vBCRet) + format: double + nullable: true + icmsRetentionRate: + type: number + description: Alíquota da Retenção (pICMSRet) //Change to Rate + format: double + nullable: true + icmsRetentionAmount: + type: number + description: Valor do ICMS Retido (vICMSRet) + format: double + nullable: true + cfop: + type: integer + description: CFOP de Serviço de Transporte (CFOP) + format: int64 + nullable: true + cityGeneratorFactCode: + type: integer + description: Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) + format: int64 + nullable: true + additionalProperties: false + TransportVehicleResource: + type: object + properties: + plate: + type: string + description: Placa do Veiculo (placa) + nullable: true + state: + type: string + description: Sigla da UF (UF) + nullable: true + rntc: + type: string + description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Veiculo" + VolumeResource: + type: object + properties: + volumeQuantity: + type: integer + description: Quantidade de volumes transportados (qVol) + format: int32 + nullable: true + species: + type: string + description: Espécie dos volumes transportados (esp) + nullable: true + brand: + type: string + description: Marca dos Volumes Transportados (marca) + nullable: true + volumeNumeration: + type: string + description: Numeração dos Volumes Transportados (nVol) + nullable: true + netWeight: + type: number + description: Peso Liquido(em Kg) (pesoL) + format: double + nullable: true + grossWeight: + type: number + description: Peso Bruto(em Kg) (pesoB) + format: double + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nVolumes\r\nId:X26" + WithdrawalInformationResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: Identificação do Local de retirada (retirada) + AdvancePaymentItemResource: + type: object + properties: + accessKey: + type: string + nullable: true + additionalProperties: false + description: Grupo de notas de antecipação de pagamento - Informado para abater as parcelas de antecipação + de pagamento, conforme Art. 10. § 4º (gPagAntecipado). + CBSTaxResource: + type: object + description: Grupo de Informações da CBS + properties: + rate: + type: number + nullable: true + description: Alíquota da CBS (em percentual) (pCBS) + format: double + deferment: + description: Grupo de Informações do Diferimento (gDif) + $ref: '#/components/schemas/DefermentTaxResource' + returnedAmount: + description: Grupo de Informações da Devolução de Tributos (gDevTrib) + $ref: '#/components/schemas/ReturnedTaxResource' + reduction: + description: Grupo de informações da redução da alíquota (gRed) + $ref: '#/components/schemas/ReductionTaxResource' + amount: + type: number + nullable: true + description: Valor total da CBS (vCBS). + format: double + additionalProperties: false + CBSTotalsResource: + type: object + nullable: true + description: Grupo total da CBS (gCBS) + properties: + defermentAmount: + type: number + nullable: true + description: Valor total do diferimento (vDif) + format: double + returnedAmount: + type: number + nullable: true + description: Valor total de devolução de tributos (vDevTrib) + format: double + amount: + type: number + nullable: true + description: Valor total da CBS (vCBS) + format: double + presumedCreditAmount: + type: number + nullable: true + description: Valor total do crédito presumido (vCredPres) + format: double + presumedCreditConditionalAmount: + type: number + nullable: true + description: Valor total do crédito presumido em condição suspensiva. (vCredPresCondSus) + format: double + additionalProperties: false + CompetenceAdjustmentResource: + type: object + description: Ajuste de Competência (gAjusteCompet) + properties: + assessmentPeriod: + type: string + nullable: true + description: Ano e mês referência do período de apuração (AAAA-MM) (competApur) + ibsAmount: + type: number + nullable: true + description: Valor de IBS referente ao ajuste de competência (vIBS) + format: double + cbsAmount: + type: number + nullable: true + description: Valor de CBS referente ao ajuste de competência (vCBS) + format: double + additionalProperties: false + ConsumptionCityCode: + type: integer + nullable: true + description: 'Código do Município de ocorrência do fato gerador do IBS/CBS (cMunFGIBS). Informar o município + de ocorrência do fato gerador do IBS/CBS. Este campo só é preenchido quando "indPres = 5 (Operação presencial, + fora do estabelecimento)" e não incluir o endereço do destinatário (Grupo: E05) ou local de entrega (Grupo: + G01).' + format: int64 + CreditReversalResource: + type: object + description: Estorno de Crédito (gEstornoCred) + properties: + ibsReversalAmount: + type: number + nullable: true + description: Valor do IBS a ser estornado (vIBSEstCred) + format: double + cbsReversalAmount: + type: number + nullable: true + description: Valor da CBS a ser estornada (vCBSEstCred) + format: double + additionalProperties: false + CreditReversalTotalsResource: + type: object + description: Estorno de Crédito (gEstornoCred) + properties: + ibsReversalAmount: + type: number + nullable: true + description: Valor do IBS a ser estornado (vIBSEstCred) + format: double + cbsReversalAmount: + type: number + nullable: true + description: Valor da CBS a ser estornada (vCBSEstCred) + format: double + additionalProperties: false + CreditTransferTaxResource: + type: object + description: Informações de Transferências de Crédito (gTransfCred) + properties: + ibsAmount: + type: number + nullable: true + description: Valor de IBS a transferir (vIBS). + format: double + cbsAmount: + type: number + nullable: true + description: Valor de CBS a transferir (vCBS). + format: double + additionalProperties: false + DefermentTaxResource: + type: object + description: Grupo de Informações do Diferimento + properties: + rate: + type: number + nullable: true + description: Percentual do diferimento + format: double + amount: + type: number + nullable: true + description: Valor do Diferimento + format: double + additionalProperties: false + GovernmentPurchaseEntityType: + type: string + nullable: true + description: 'Tipo de ente governamental (tpEnteGov). Para administração pública direta e suas autarquias + e fundações. + + Valores possíveis: + + - `Union`: União + + - `State`: Estado + + - `FederalDistrict`: Distrito Federal + + - `Municipality`: Município + + ' + enum: + - Union + - State + - FederalDistrict + - Municipality + GovernmentPurchaseOperationType: + type: string + nullable: true + description: 'Tipo de operação com o ente governamental (tpOperGov). + + Valores possíveis: + + - `Supply`: Fornecimento + + - `Payment`: Recebimento do pagamento + + - `SupplyThenPay`: Fornecimento e pagamento simultâneo + + - `PayForPastSupply`: Pagamento por fornecimento passado + + - `SupplyAfterPay`: Fornecimento após pagamento + + - `PayNowSupplyLater`: Pagamento agora, fornecimento depois + + - `SupplyAndPayNow`: Fornecimento e pagamento agora + + ' + enum: + - Supply + - Payment + - SupplyThenPay + - PayForPastSupply + - SupplyAfterPay + - PayNowSupplyLater + - SupplyAndPayNow + GovernmentPurchaseResource: + type: object + description: Grupo de Compras Governamentais (gCompraGov). Grupo opcional. Informar apenas para compras governamentais. + properties: + entityType: + $ref: '#/components/schemas/GovernmentPurchaseEntityType' + rateReduction: + type: number + nullable: true + description: Percentual de redução de alíquota em compra governamental (pRedutor). Conforme o art. 472/370 + da LC 214/2025. + format: double + operationType: + $ref: '#/components/schemas/GovernmentPurchaseOperationType' + additionalProperties: false + GovernmentPurchaseTaxResource: + type: object + description: Grupo de informações sobre a composição do valor do IBS e CBS nas compras governamentais. Informar + apenas para compras governamentais. + properties: + stateRate: + type: number + nullable: true + description: Alíquota IBS UF em compras governamentais (pAliqIBSUF). + format: double + stateAmount: + type: number + nullable: true + description: Valor IBS UF em compras governamentais (vTribIBSUF). + format: double + municipalRate: + type: number + nullable: true + description: Alíquota IBS Município em compras governamentais (pAliqIBSMun). + format: double + municipalAmount: + type: number + nullable: true + description: Valor IBS Município em compras governamentais (vTribIBSMun). + format: double + cbsRate: + type: number + nullable: true + description: Alíquota CBS em compras governamentais (pAliqCBS). + format: double + cbsAmount: + type: number + nullable: true + description: Valor CBS em compras governamentais (vTribCBS) + format: double + additionalProperties: false + IBSCBSTaxResource: + type: object + description: Grupo de Informações do IBS e CBS + properties: + situationCode: + type: string + nullable: true + description: Código de Situação Tributária do IBS/CBS (CST). Campo opcional. Se preenchido, será considerado; + caso contrário, será definido com base no valor informado no campo `classCode`. Consulte a tabela de + referência de `situationCode` (CST) disponível na nossa documentação funcional. + maxLength: 3 + classCode: + type: string + nullable: true + description: Código de Classificação Tributária do IBS/CBS (cClassTrib). Consulte a tabela de referência + [cClassTrib](https://nfe.io/docs/documentacao/reforma-tributaria/conceitos-funcionais/tabelas-de-referencia/tabela-referencia-cst-classificacao-tributaria-ibs-cbs/) + disponível na nossa documentação funcional. + maxLength: 6 + calculationMode: + type: string + nullable: true + description: 'Modo de cálculo do IBS/CBS. + + Valores possíveis: + + - `Manual`: Preenchimento manual dos campos de tributo. + + - `OfficialService`: Utiliza o serviço oficial para calcular IBS/CBS. Quando ativo, apenas `situationCode` + e `classCode` são necessários; os demais campos de tributo são ignorados na entrada e preenchidos pelo + serviço. + + ' + enum: + - Manual + - OfficialService + default: Manual + donationIndicator: + type: string + nullable: true + description: Indica a natureza da operação de doação, orientando a apuração e a geração de débitos ou + estornos conforme o cenário (indDoacao). Informar quando for doação. + maxLength: 1 + basis: + type: number + nullable: true + description: Base de cálculo antes de reduções para cálculo do tributo bruto. Este campo é opcional. Se + enviado, será considerado; caso contrário, será calculado. + format: double + state: + $ref: '#/components/schemas/IBSStateTaxResource' + municipal: + $ref: '#/components/schemas/IBSMunicipalTaxResource' + ibsTotalAmount: + type: number + nullable: true + description: Total do IBS (vIBSTot = vIBSUF + vIBSMun). Quando houver crédito presumido com o indicador + "IndDeduzCredPres=1", o valor de vCredPres deve ser deduzido deste total. + format: double + cbs: + $ref: '#/components/schemas/CBSTaxResource' + regularTaxation: + description: Tributação regular hipotética caso condição resolutória/suspensiva não se aplique. + $ref: '#/components/schemas/RegularTaxationResource' + governmentPurchase: + description: Grupo de informações sobre a composição do valor do IBS e CBS nas compras governamentais. + $ref: '#/components/schemas/GovernmentPurchaseTaxResource' + monophase: + description: Grupo de Informações do IBS e CBS sobre transações monofásicas + $ref: '#/components/schemas/MonophaseIBSCBSTaxResource' + creditTransfer: + description: Grupo de Informações sobre Transferências de Crédito + $ref: '#/components/schemas/CreditTransferTaxResource' + operationalPresumedCredit: + description: Informações sobre o crédito presumido operacional (gCredPresOper). + $ref: '#/components/schemas/OperationalPresumedCreditResource' + creditReversal: + description: 'Estorno de Crédito (gEstornoCred). Observação: a obrigatoriedade ou vedação do preenchimento + deste grupo está condicionada ao indicador “ind_gEstornoCred” da tabela de cClassTrib do IBS e da CBS.' + $ref: '#/components/schemas/CreditReversalResource' + zfmPresumedCredit: + description: Informações sobre o crédito presumido de IBS para fornecimentos da ZFM (gCredPresIBSZFM). + $ref: '#/components/schemas/ZfmPresumedCreditResource' + additionalProperties: false + IBSCBSTotalsResource: + type: object + nullable: true + description: Totais da NF-e com IBS e CBS. (IBSCBSTot) + properties: + basis: + type: number + nullable: true + description: Valor total da Base de Cálculo do IBS e da CBS. (vBCIBSCBS) + format: double + ibs: + description: Grupo total do IBS (gIBS) + $ref: '#/components/schemas/IBSTotalsResource' + cbs: + description: Grupo total da CBS (gCBS) + $ref: '#/components/schemas/CBSTotalsResource' + monophase: + description: Grupo de totais da tributação monofásica. + $ref: '#/components/schemas/MonophaseTotalsResource' + creditReversal: + description: Grupo total do Estorno de Crédito (gEstornoCred) + $ref: '#/components/schemas/CreditReversalTotalsResource' + additionalProperties: false + IBSMunicipalTaxResource: + type: object + description: Grupo de Informações do IBS para o município + properties: + rate: + type: number + nullable: true + description: Alíquota IBS (Município) (%). + format: double + deferment: + $ref: '#/components/schemas/DefermentTaxResource' + returnedAmount: + $ref: '#/components/schemas/ReturnedTaxResource' + reduction: + $ref: '#/components/schemas/ReductionTaxResource' + amount: + type: number + nullable: true + description: Valor do IBS do Município (vIBSMun). + format: double + additionalProperties: false + IBSMunicipalTotalsResource: + type: object + nullable: true + description: Informações do IBS do Município (gIBSMun) + properties: + defermentAmount: + type: number + nullable: true + description: Valor total do diferimento (vDif) + format: double + returnedAmount: + type: number + nullable: true + description: Valor total de devolução de tributos (vDevTrib) + format: double + amount: + type: number + nullable: true + description: Valor total do IBS do Município. (vIBSMun) + format: double + additionalProperties: false + IBSStateTaxResource: + type: object + description: Grupo de Informações do IBS para a UF + properties: + rate: + type: number + nullable: true + description: Alíquota do IBS de competência das UF (em percentual). Alíquota vigente do IBS da UF.Preencher + de acordo com a tabela de alíquotas do IBS e CBS. + format: double + deferment: + $ref: '#/components/schemas/DefermentTaxResource' + returnedAmount: + $ref: '#/components/schemas/ReturnedTaxResource' + reduction: + $ref: '#/components/schemas/ReductionTaxResource' + amount: + type: number + nullable: true + description: Valor do IBS da UF (vIBSUF). + format: double + additionalProperties: false + IBSStateTotalsResource: + type: object + nullable: true + description: Informações do IBS da UF (gIBSUF) + properties: + defermentAmount: + type: number + nullable: true + description: Valor total do diferimento (vDif) + format: double + returnedAmount: + type: number + nullable: true + description: Valor total de devolução de tributos (vDevTrib) + format: double + amount: + type: number + nullable: true + description: Valor total do IBS da UF. (vIBSUF) + format: double + additionalProperties: false + IBSTotalsResource: + type: object + nullable: true + description: Grupo total do IBS (gIBS) + properties: + state: + description: Informações do IBS da UF. + $ref: '#/components/schemas/IBSStateTotalsResource' + municipal: + description: Informações do IBS do Município. + $ref: '#/components/schemas/IBSMunicipalTotalsResource' + totalAmount: + type: number + nullable: true + description: Valor total do IBS (vIBS) + format: double + presumedCreditAmount: + type: number + nullable: true + description: Valor total do crédito presumido (vCredPres) + format: double + presumedCreditConditionalAmount: + type: number + nullable: true + description: Valor total do crédito presumido em condição suspensiva. (vCredPresCondSus) + format: double + additionalProperties: false + ISTaxResource: + type: object + description: Imposto Seletivo (IS). Informe quando o item estiver sujeito ao IS. + properties: + situationCode: + type: string + nullable: true + description: CST do Imposto Seletivo (IS). Código de Situação Tributária de 3 dígitos (CST). Consulte + a tabela de referência. + classificationCode: + type: string + nullable: true + description: Código de Classificação Tributária do IS (cClassTribIS), 6 dígitos. Consulte a tabela de + referência. + basis: + type: number + nullable: true + description: Base de cálculo do IS (vBCIS). 15 posições, 13 inteiros e 2 decimais. + format: double + rate: + type: number + nullable: true + description: Alíquota do IS em percentual (pIS). Até 4 casas decimais. + format: double + unitRate: + type: number + nullable: true + description: Alíquota específica por unidade (pISEspec), em R$ por unidade tributável. + format: double + unit: + type: string + nullable: true + description: Unidade tributável usada quando houver alíquota específica por unidade (uTrib). + quantity: + type: number + nullable: true + description: Quantidade tributável usada quando houver alíquota específica por unidade (qTrib). Até 4 + casas decimais. + format: double + amount: + type: number + nullable: true + description: Valor do Imposto Seletivo (vIS). 15 posições, 13 inteiros e 2 decimais. + format: double + additionalProperties: false + ISTotalsResource: + type: object + nullable: true + description: Grupo de totais do Imposto Seletivo. (ISTot) + properties: + amount: + type: number + nullable: true + description: Total do imposto seletivo. (vIS) + format: double + additionalProperties: false + IbsConsumptionCityCode: + type: integer + nullable: true + description: 'Código do Município de ocorrência do fato gerador do IBS/CBS (cMunFGIBS). Informar o município + de ocorrência do fato gerador do IBS/CBS. Este campo só é preenchido quando "indPres = 5 (Operação presencial, + fora do estabelecimento)" e não incluir o endereço do destinatário (Grupo: E05) ou local de entrega (Grupo: + G01).' + format: int64 + IbsZfmPresumedCreditClassification: + type: string + nullable: true + description: 'Classificação para cálculo do crédito presumido de IBS para fornecimentos da ZFM (tpCredPresIBSZFM). + + Valores possíveis: + + - `NoPresumedCredit`: Sem Crédito Presumido + + - `FinalConsumptionGoods`: Bens de consumo final (55%) + + - `CapitalGoods`: Bens de capital (75%) + + - `IntermediateGoods`: Bens intermediários (90,25%) + + - `ItAndOtherGoods`: Bens de informática e outros definidos em legislação (100%) + + ' + enum: + - NoPresumedCredit + - FinalConsumptionGoods + - CapitalGoods + - IntermediateGoods + - ItAndOtherGoods + MonophaseCBSTotalsResource: + type: object + nullable: true + description: Totais da CBS monofásica + properties: + amount: + type: number + nullable: true + description: Total da CBS monofásica. (vCBSMono) + format: double + withheldAmount: + type: number + nullable: true + description: Total da CBS monofásica sujeita a retenção. (vCBSMonoReten) + format: double + previouslyWithheldAmount: + type: number + nullable: true + description: Total da CBS monofásica retida anteriormente. (vCBSMonoRet) + format: double + additionalProperties: false + MonophaseDefermentTaxResource: + type: object + description: Deferimento na tributação monofásica (para biocombustíveis). + properties: + ibsRate: + type: number + nullable: true + description: Percentual de diferimento do IBS monofásico (pDifIBS). + format: double + ibsAmount: + type: number + nullable: true + description: Valor do diferimento IBS monofásico (vIBSMonoDif). + format: double + cbsRate: + type: number + nullable: true + description: Percentual de diferimento do CBS monofásico (pDifCBS). + format: double + cbsAmount: + type: number + nullable: true + description: Valor do diferimento CBS monofásico (vCBSMonoDif). + format: double + additionalProperties: false + MonophaseIBSCBSTaxResource: + type: object + description: Grupo de Informações do IBS e CBS sobre transações monofásicas + properties: + standart: + description: Informações de tributação monofásica padrão para IBS/CBS (gMonofasicoPadrao). + $ref: '#/components/schemas/MonophaseStandardTaxResource' + withholding: + description: Tributação monofásica sujeita à retenção (gMonofasicoRetido). + $ref: '#/components/schemas/MonophaseWithholdingTaxResource' + previouslyWithheld: + description: Tributação monofásica previamente retida (gMonofasicoRetidoAnt). + $ref: '#/components/schemas/MonophasePreviouslyWithheldTaxResource' + deferment: + description: Deferimento na tributação monofásica (para biocombustíveis) (gMonofasicoDif). + $ref: '#/components/schemas/MonophaseDefermentTaxResource' + ibsAmount: + type: number + nullable: true + description: Total de IBS monofásico do item (vTotIBSMonoItem). + format: double + cbsAmount: + type: number + nullable: true + description: Total de CBS monofásico do item (vTotCBSMonoItem). + format: double + additionalProperties: false + MonophaseIBSTotalsResource: + type: object + nullable: true + description: Totais do IBS monofásico + properties: + amount: + type: number + nullable: true + description: Total do IBS monofásico. (vIBSMono) + format: double + withheldAmount: + type: number + nullable: true + description: Total do IBS monofásico sujeito a retenção. (vIBSMonoReten) + format: double + previouslyWithheldAmount: + type: number + nullable: true + description: Total do IBS monofásico retido anteriormente. (vIBSMonoRet) + format: double + additionalProperties: false + MonophasePreviouslyWithheldTaxResource: + type: object + description: Tributação monofásica previamente retida. + properties: + quantityBasis: + type: number + nullable: true + description: Quantidade base previamente retida (qBCMonoRet). + format: double + ibsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem IBS previamente retida (adRemIBSRet). + format: double + ibsAmount: + type: number + nullable: true + description: Valor IBS previamente retido (vIBSMonoRet). + format: double + cbsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem CBS previamente retida (adRemCBSRet). + format: double + cbsAmount: + type: number + nullable: true + description: Valor CBS previamente retido (vCBSMonoRet). + format: double + additionalProperties: false + MonophaseStandardTaxResource: + type: object + description: Informações de tributação monofásica padrão para IBS/CBS. + properties: + quantityBasis: + type: number + nullable: true + description: Quantidade base tributada na monofásica (qBCMono). + format: double + ibsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem IBS (adRemIBS). + format: double + cbsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem CBS (adRemCBS). + format: double + ibsAmount: + type: number + nullable: true + description: Valor IBS monofásico (vIBSMono). + format: double + cbsAmount: + type: number + nullable: true + description: Valor CBS monofásico (vCBSMono). + format: double + additionalProperties: false + MonophaseTotalsResource: + type: object + nullable: true + description: Grupo de totais da tributação monofásica. + properties: + ibs: + description: Totais do IBS monofásico + $ref: '#/components/schemas/MonophaseIBSTotalsResource' + cbs: + description: Totais da CBS monofásica + $ref: '#/components/schemas/MonophaseCBSTotalsResource' + additionalProperties: false + MonophaseWithholdingTaxResource: + type: object + description: Tributação monofásica sujeita à retenção. + properties: + quantityBasis: + type: number + nullable: true + description: Quantidade base tributada na retenção monofásica (qBCMonoReten). + format: double + ibsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem IBS retida (adRemIBSReten). + format: double + ibsAmount: + type: number + nullable: true + description: Valor IBS monofásico retido (vIBSMonoReten). + format: double + cbsAdRemRate: + type: number + nullable: true + description: Alíquota ad rem CBS retida (adRemCBSReten). + format: double + cbsAmount: + type: number + nullable: true + description: Valor CBS monofásico retido (vCBSMonoReten). + format: double + additionalProperties: false + OperationalPresumedCreditResource: + type: object + description: Informações sobre o crédito presumido de IBS para fornecimentos (gCredPresOper). + properties: + basis: + type: number + nullable: true + description: Valor da Base de Cálculo do Crédito Presumido da Operação (vBC) + format: double + classificationCode: + description: Código de Classificação do Crédito Presumido (cCredPres). + $ref: '#/components/schemas/PresumedCreditClassificationCode' + ibs: + description: Grupo de Informações do Crédito Presumido referente ao IBS (gIBSCredPres) + $ref: '#/components/schemas/PresumedCreditDetailsResource' + cbs: + description: Grupo de Informações do Crédito Presumido referente a CBS (gCBSCredPres) + $ref: '#/components/schemas/PresumedCreditDetailsResource' + additionalProperties: false + PresumedCreditClassificationCode: + type: string + nullable: true + enum: + - RuralProducerNonTaxpayer + - TacPfTransportServiceNonTaxpayer + - RecyclingFromIndividual + - UsedMovableGoodsFromIndividualForResale + - OptionalRegimeForCooperative + description: 'Código de Classificação do Crédito Presumido (cCredPres). + + Valores possíveis: + + - `RuralProducerNonTaxpayer`: Produtor rural não contribuinte + + - `TacPfTransportServiceNonTaxpayer`: TAC Pessoa Física não contribuinte do serviço de transporte + + - `RecyclingFromIndividual`: Reciclagem de pessoa física + + - `UsedMovableGoodsFromIndividualForResale`: Bens móveis usados de pessoa física para revenda + + - `OptionalRegimeForCooperative`: Regime opcional para cooperativa + + ' + PresumedCreditDetailsResource: + type: object + description: Grupo de Informações do Crédito Presumido + properties: + rate: + type: number + nullable: true + description: Percentual do Crédito Presumido (pCredPres) + format: double + amount: + type: number + nullable: true + description: Valor do Crédito Presumido (vCredPres) + format: double + suspensiveConditionAmount: + type: number + nullable: true + description: Valor do Crédito Presumido em condição suspensiva. (vCredPresCondSus) + format: double + additionalProperties: false + PresumedCreditResource: + type: object + description: Informações de Crédito Presumido por item (gCred). Preenchimento conforme exigência da UF (NT + 2019.001). + properties: + code: + type: string + nullable: true + description: Código do Benefício de Crédito Presumido na UF (cCredPresumido). Use o mesmo código utilizado + na EFD/declarações da UF. Tamanho 8 ou 10. + rate: + type: number + nullable: true + description: 'Percentual do Crédito Presumido (pCredPresumido). Use fração: 0.04 = 4%. Até 4 casas decimais.' + format: double + amount: + type: number + nullable: true + description: Valor do Crédito Presumido (vCredPresumido). + format: double + additionalProperties: false + ReductionTaxResource: + type: object + description: Grupo de informações da redução da alíquota + properties: + rateReduction: + type: number + nullable: true + description: Percentual da redução de alíquota + format: double + effectiveRate: + type: number + nullable: true + description: Alíquota Efetiva que será aplicada a Base de Cálculo (em percentual) + format: double + additionalProperties: false + ReferencedDFeResource: + type: object + nullable: true + description: Documento Fiscal Eletrônico Referenciado (DFeReferenciado). Grupo para referenciamento de itens + de outro DF-e. + properties: + accessKey: + type: string + description: Chave de acesso do DF-e referenciado (chaveAcesso). + maxLength: 44 + minLength: 44 + pattern: ^[0-9]{44}$ + itemNumber: + type: integer + nullable: true + description: Número do item do documento referenciado (nItem). Corresponde ao atributo “nItem” do elemento + “det” do documentooriginal. + maximum: 999 + minimum: 1 + format: int32 + required: + - accessKey + additionalProperties: false + RegularTaxationResource: + type: object + description: Tributação regular hipotética caso condição resolutória/suspensiva não se aplique. Informar como + a tributação seria aplicada se a condição resolutória/suspensiva não for atendida. + properties: + situationCode: + type: string + nullable: true + description: CST regular (CSTReg), 3 dígitos. Use tabela CST do IBS/CBS + classCode: + type: string + nullable: true + description: Classificação tributária regular (cClassTribReg), 6 dígitos. Use tabela cClassTrib + stateEffectiveRate: + type: number + nullable: true + description: Alíquota efetiva IBS UF (pAliqEfetRegIBSUF). + format: double + amount: + type: number + nullable: true + description: IBS UF regular (vTribRegIBSUF). + format: double + municipalEffectiveRate: + type: number + nullable: true + description: Alíquota efetiva IBS Município (pAliqEfetRegIBSMun). + format: double + municipalAmount: + type: number + nullable: true + description: IBS Município regular (vTribRegIBSMun). + format: double + cbsEffectiveRate: + type: number + nullable: true + description: Alíquota efetiva CBS (pAliqEfetRegCBS). + format: double + cbsAmount: + type: number + nullable: true + description: CBS regular (vTribRegCBS). + format: double + additionalProperties: false + ReturnedTaxResource: + type: object + description: Grupo de Informações da Devolução de Tributos + properties: + amount: + type: number + nullable: true + description: Valor do tributo devolvido (vDevTrib) + format: double + additionalProperties: false + TotalsWithholdings: + type: object + nullable: true + description: Grupo Retenções de Tributos (retTrib) + properties: + pisAmount: + type: number + nullable: true + description: Valor Retido de PIS (vRetPIS) + format: double + maximum: 9999999999999.99 + minimum: 0 + cofinsAmount: + type: number + nullable: true + description: Valor Retido de COFINS (vRetCOFINS) + format: double + maximum: 9999999999999.99 + minimum: 0 + csllAmount: + type: number + nullable: true + description: Valor Retido de CSLL (vRetCSLL) + format: double + maximum: 9999999999999.99 + minimum: 0 + irrfBasis: + type: number + nullable: true + description: Base de Cálculo do IRRF (vBCIRRF) + format: double + maximum: 9999999999999.99 + minimum: 0 + irrfAmount: + type: number + nullable: true + description: Valor Retido do IRRF (vIRRF) + format: double + maximum: 9999999999999.99 + minimum: 0 + socialSecutiryBasis: + type: number + nullable: true + description: Base de Cálculo da Retenção da Previdência Social (vBCRetPrev) + format: double + maximum: 9999999999999.99 + minimum: 0 + socialSecutiryAmount: + type: number + nullable: true + description: Valor da Retenção da Previdência Social (vRetPrev) + format: double + maximum: 9999999999999.99 + minimum: 0 + additionalProperties: false + UsedMovableAssetIndicator: + type: boolean + nullable: false + description: Indica fornecimento de bem móvel usado (indBemMovelUsado). true = bem usado; false = bem novo. + VehicleDetailResource: + type: object + description: Detalhamento de Veículos novos (veicProd) - grupo J01 + properties: + operationType: + type: integer + nullable: true + description: 'Tipo da Operação (tpOp). + + Valores possíveis: + + - `0`: Outros + + - `1`: Venda concessionária + + - `2`: Faturamento direto para consumidor final + + - `3`: Venda direta para grandes consumidores + + ' + format: int32 + enum: + - 0 + - 1 + - 2 + - 3 + chassis: + type: string + nullable: true + description: Chassi do veículo - VIN (chassi). 17 caracteres alfanuméricos + minLength: 17 + maxLength: 17 + pattern: ^[A-Z0-9]+$ + colorCode: + type: string + nullable: true + description: Cor do veículo - código de cada montadora (cCor) + maxLength: 4 + colorDescription: + type: string + nullable: true + description: Descrição da Cor (xCor) + maxLength: 40 + enginePower: + type: string + nullable: true + description: Potência máxima do motor em cavalo vapor - CV (pot) + maxLength: 4 + engineDisplacement: + type: string + nullable: true + description: Capacidade volumétrica do motor em centímetros cúbicos - CC (cilin) + maxLength: 4 + netWeight: + type: string + nullable: true + description: Peso Líquido (pesoL) + maxLength: 9 + grossWeight: + type: string + nullable: true + description: Peso Bruto (pesoB) + maxLength: 9 + serialNumber: + type: string + nullable: true + description: Serial - série (nSerie) + maxLength: 9 + fuelType: + type: string + nullable: true + description: 'Tipo de combustível - Tabela RENAVAM (tpComb). Ex: 01-Álcool; 02-Gasolina; 03-Diesel; 16-Álcool/Gas.; + 17-Gas./Álcool/GNV; 18-Gasolina/Elétrico' + maxLength: 2 + engineNumber: + type: string + nullable: true + description: Número do motor (nMotor) + maxLength: 21 + maximumTractionCapacity: + type: string + nullable: true + description: Capacidade Máxima de Tração em toneladas - 4 casas decimais (CMT) + maxLength: 9 + wheelBase: + type: string + nullable: true + description: Distância entre eixos (dist) + maxLength: 4 + modelYear: + type: integer + nullable: true + description: 'Ano Modelo de Fabricação (anoMod). Formato: 4 dígitos' + format: int32 + manufactureYear: + type: integer + nullable: true + description: 'Ano de Fabricação (anoFab). Formato: 4 dígitos' + format: int32 + paintType: + type: string + nullable: true + description: Tipo de pintura (tpPint) + maxLength: 1 + vehicleType: + type: string + nullable: true + description: Tipo de veículo - Tabela RENAVAM (tpVeic) + maxLength: 2 + vehicleSpecies: + type: integer + nullable: true + description: Espécie de veículo - Tabela RENAVAM (espVeic) + format: int32 + vinCondition: + type: string + nullable: true + description: 'Condição do VIN — chassi (VIN). + + Valores possíveis: + + - `R`: Remarcado (chassi regravado pelo DETRAN) + + - `N`: Normal (chassi original de fábrica) + + ' + enum: + - R + - N + vehicleCondition: + type: integer + nullable: true + description: 'Condição do veículo (condVeic). + + Valores possíveis: + + - `1`: Acabado (veículo pronto para uso) + + - `2`: Inacabado (veículo sem algum componente essencial) + + - `3`: Semi-acabado (veículo parcialmente montado, ex: chassis-cabina) + + ' + format: int32 + enum: + - 1 + - 2 + - 3 + brandModelCode: + type: string + nullable: true + description: Código Marca Modelo - Tabela RENAVAM (cMod) + maxLength: 6 + denatranColorCode: + type: string + nullable: true + description: Código da Cor DENATRAN (cCorDENATRAN). 01-AMARELO; 02-AZUL; 03-BEGE; 04-BRANCA; 05-CINZA; + 06-DOURADA; 07-GRENA; 08-LARANJA; 09-MARROM; 10-PRATA; 11-PRETA; 12-ROSA; 13-ROXA; 14-VERDE; 15-VERMELHA; + 16-FANTASIA + maxLength: 2 + seatingCapacity: + type: integer + nullable: true + description: Quantidade máxima de passageiros sentados, inclusive motorista (lota) + format: int32 + restrictionType: + type: integer + nullable: true + description: 'Tipo de restrição sobre o veículo (tpRest). + + Valores possíveis: + + - `0`: Não há restrição (veículo livre para venda e transferência) + + - `1`: Alienação Fiduciária (veículo dado como garantia em financiamento) + + - `2`: Arrendamento Mercantil (veículo em contrato de leasing) + + - `3`: Reserva de Domínio (vendedor mantém a propriedade até quitação total) + + - `4`: Penhor de Veículos (veículo dado como garantia em empréstimo) + + - `9`: Outras restrições + + ' + format: int32 + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 9 + additionalProperties: false + ZfmPresumedCreditResource: + type: object + description: Informações sobre o crédito presumido de IBS para fornecimentos da ZFM (gCredPresIBSZFM). + properties: + classificationCode: + description: Tipo de crédito presumido (tpCredPresIBSZFM). + $ref: '#/components/schemas/IbsZfmPresumedCreditClassification' + amount: + type: number + nullable: true + description: Valor do crédito presumido ZFM (vCredPresIBSZFM). Obrigatório para notas de crédito com tpNFCredito + = 02. + format: double + additionalProperties: false + securitySchemes: + Authorization_Header: + type: apiKey + description: Autenticar usando o cabeçalho HTTP + name: Authorization + in: header + Authorization_QueryParam: + type: apiKey + description: Autenticar usando o parâmetro na URL + name: apikey + in: query + Authorization_JwtBearer: + type: http + description: Autenticar usando o cabeçalho HTTP + scheme: bearer + bearerFormat: Json Web Token +security: +- Authorization_Header: [] + Authorization_QueryParam: [] +- Authorization_JwtBearer: [] +x-original-swagger-version: '2.0' diff --git a/openapi/nf-produto-v2.yaml b/openapi/nf-produto-v2.yaml index 1d8d996..833ac8a 100644 --- a/openapi/nf-produto-v2.yaml +++ b/openapi/nf-produto-v2.yaml @@ -4,7 +4,7 @@ info: description: "# Introducão\nSeja bem-vindo a documentação da API de Nota Fiscal de Produto!\nNossa API foi criada utilizando o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada abaixo.\n\n\n# Como usar a API?\nLogo a seguir você encontrará todos os recursos e metódos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\n\n\n# Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra no topo desta página para que os métodos funcionem corretamente.\nNo seu código de integração temos suporte para autenticação de diversas formas sendo eles: \nHTTP Header (Authorization) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).\n\n" version: v2 servers: - - url: https://api.nfse.io/ + - url: https://api.nfse.io tags: - name: Companies description: | @@ -7490,6 +7490,10 @@ components: $ref: '#/components/schemas/EnvironmentType' purposeType: $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' issuer: $ref: '#/components/schemas/IssuerResource' buyer: @@ -7591,6 +7595,10 @@ components: $ref: '#/components/schemas/EnvironmentType' purposeType: $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' issuer: $ref: '#/components/schemas/IssuerResource' buyer: @@ -8029,6 +8037,10 @@ components: $ref: '#/components/schemas/PrintType' purposeType: $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' consumerType: $ref: '#/components/schemas/ConsumerType' presenceType: @@ -8125,6 +8137,8 @@ components: - Complement - Adjustment - Devolution + - CreditInvoice + - DebitInvoice type: string description: | Finalidade da emissão da NF-e (finNFe). @@ -8134,6 +8148,43 @@ components: - `Complement` (2): NF-e Complementar (complementa valores de uma nota anterior) - `Adjustment` (3): NF-e de Ajuste (regulariza divergências fiscais) - `Devolution` (4): Devolução de mercadoria + - `CreditInvoice` (5): Nota de Crédito (Reforma Tributária, Ajuste SINIEF 49/25) — requer `creditType` + - `DebitInvoice` (6): Nota de Débito (Reforma Tributária, Ajuste SINIEF 49/25) — requer `debitType` + CreditType: + enum: + - RefusedDeliveryTotalOrNotFound + - RefusedDeliveryPartial + type: string + nullable: true + description: | + Tipo de Nota de Crédito (tpNFCredito). Obrigatório quando `purposeType=CreditInvoice`. + - `RefusedDeliveryTotalOrNotFound` (03): Retorno por Recusa TOTAL na Entrega ou por Não Localização do Destinatário + - `RefusedDeliveryPartial` (06): Retorno por Recusa PARCIAL na Entrega (Ajuste SINIEF 8/26; a referência por item — `referencedDFe` — segue o contrato RTC, ver a API "Nota de Produto/Consumidor RTC") + DebitType: + enum: + - TransferCreditsToCooperatives + - CancelCreditsExemptImmuneSales + - UnprocessedInvoicesDebits + - FinesAndInterest + - TransferInheritanceCredit + - AdvancePayment + - InventoryLoss + - SnDisqualification + type: string + nullable: true + description: | + Tipo de Nota de Débito (tpNFDebito). Obrigatório quando `purposeType=DebitInvoice`. + - `TransferCreditsToCooperatives` (01): Transferência de créditos para cooperativas + - `CancelCreditsExemptImmuneSales` (02): Cancelamento de créditos por vendas isentas/imunes + - `UnprocessedInvoicesDebits` (03): Débitos de faturas não processadas + - `FinesAndInterest` (04): Multas e juros + - `TransferInheritanceCredit` (05): Transferência de crédito na sucessão + - `AdvancePayment` (06): Pagamento antecipado + - `InventoryLoss` (07): Perda de estoque + - `SnDisqualification` (08): Desenquadramento do Simples Nacional + x-nota: | + Os campos de item específicos das hipóteses de débito (grupos IBS/CBS `competenceAdjustment`/`gAjusteCompet` + e `creditReversal`/`gEstornoCred`) seguem o contrato RTC — ver a API "Nota de Produto/Consumidor RTC". QueueEventResource: type: object properties: diff --git a/openapi/nf-produto-v3.yaml b/openapi/nf-produto-v3.yaml new file mode 100644 index 0000000..6db8b7d --- /dev/null +++ b/openapi/nf-produto-v3.yaml @@ -0,0 +1,4496 @@ +openapi: 3.0.1 +info: + title: Nota Fiscal de Produto (V3) + description: "**V3 — suporte a CNPJ alfanumérico (IN RFB 2.229/2024).** Esta versão aceita emitentes e destinatários\ + \ com CNPJ alfanumérico e retorna `federalTaxNumber` sempre como **string**. As versões V1/V2 permanecem congeladas\ + \ (somente CNPJ numérico). A chave de acesso de emitente alfanumérico usa Módulo 11 com ASCII−48 (NT Conjunta\ + \ ENCAT 2025.001) e é gerada automaticamente. Veja o [guia de migração](/docs/documentacao/nossa-plataforma/migracao-emissao-v2-para-v3/).\n\ + \n# Introducão\nSeja bem-vindo a documentação da API de Nota Fiscal de Produto!\nNossa API foi criada utilizando\ + \ o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender\ + \ ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada\ + \ abaixo.\n\n\n# Como usar a API?\nLogo a seguir você encontrará todos os recursos e metódos suportados pela\ + \ API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\n\n\n\ + # Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações\ + \ para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra no topo desta página para\ + \ que os métodos funcionem corretamente.\nNo seu código de integração temos suporte para autenticação de diversas\ + \ formas sendo eles: \nHTTP Header (Authorization) ou HTTP Query String (api_key) nos dois modos passando o\ + \ valor da sua chave de api (API Key).\n\n" + version: v3 +servers: +- url: https://api.nfse.io +tags: +- name: Product Invoices + description: "Nesta sessão estão disponíveis informações necessárias para emitir uma Nota Fiscal Eletrônica usando\ + \ a nossa API. \n\nVocê também encontrará informações sobre consulta de uma nota fiscal por ID, consulta de\ + \ uma lista de notas por empresa, consulta do PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) e\ + \ consulta do XML da nota fiscal eletrônica.\n" +paths: + /v3/companies/{companyId}/productinvoices: + get: + tags: + - Product Invoices + summary: Listar as Notas Fiscais Eletrônicas (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar uma lista de notas fiscais\ + \ eletrônicas por empresa." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: environment + in: query + description: Tipo de Ambiente é obrigatório (Production or Test) + required: true + schema: + $ref: '#/components/schemas/EnvironmentType' + - name: startingAfter + in: query + description: 'Id de início do contador (Default: Empty)' + schema: + type: string + - name: endingBefore + in: query + description: 'Id de fim do contador (Default: Empty)' + schema: + type: string + - name: q + in: query + description: "Buscar por parâmetros. (\"ElasticSearch string query\") Ex: (q=buyer.name:'EMPRESA LTDA').\ + \ Saiba mais\r\nem: https://nfe.io/docs/nota-fiscal-eletronica/integracao-api/consulta-elasticsearch" + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + responses: + '200': + description: Sucesso na consulta em lista + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoicesResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + post: + tags: + - Product Invoices + summary: Emitir uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica\ + \ (NFE) para fila de emissão.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o\ + \ retorno positivo\r\nnão garante a emissão do documento fiscal.\r\nPara obter um retorno ao final do processo\ + \ de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos\r\nutilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + requestBody: + description: Dados da nota fiscal a ser emitida + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + text/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/*+json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + text/xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/*+xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + responses: + '202': + description: Sucesso ao enfileirar para emissão + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}: + get: + tags: + - Product Invoices + summary: Consultar por ID uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ Eletrônica (NFE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal Eletrônica que deverá ser retornada + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/InvoiceResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + delete: + tags: + - Product Invoices + summary: Cancelar uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica\ + \ (NFE) para fila de cancelamento.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja,\ + \ o retorno positivo\r\nnão garante o cancelamento do documento fiscal.\r\nPara obter um retorno ao final\ + \ do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser cancelada + required: true + schema: + type: string + - name: reason + in: query + description: Motivo do cancelamento + schema: + type: string + responses: + '204': + description: Sucesso ao enfileirar para cancelamento + content: + application/json: + schema: + $ref: '#/components/schemas/RequestCancellationResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/credit-invoices: + get: + tags: + - Product Invoices + summary: Consultar as Notas de Crédito por recusa vinculadas a uma NF-e + description: "### Informações adicionais\r\nLista as Notas de Crédito por recusa\ + \ (tpNFCredito 03/06) que referenciaram a NF-e original informada. A lista é\ + \ sempre retornada (vazia quando não há vínculos)." + parameters: + - name: companyId + in: path + description: ID da Empresa + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID (aggregate id) da NF-e original + required: true + schema: + type: string + responses: + '200': + description: Lista de Notas de Crédito vinculadas (possivelmente vazia) + content: + application/json: + schema: + $ref: '#/components/schemas/CreditInvoicesListResource' + '404': + description: NF-e não encontrada na company informada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/credit-invoice-links: + post: + tags: + - Product Invoices + summary: Vincular manualmente uma Nota de Crédito a uma NF-e original + description: "### Informações adicionais\r\nDispara o vínculo explícito de uma\ + \ Nota de Crédito por recusa contra a NF-e original identificada por `invoiceId`\ + \ na rota. Caminho primário no modo Manual e recovery no modo Automatic.\r\n\ + **Idempotente**: chamadas repetidas com o mesmo `creditInvoiceId` retornam 202\ + \ e o vínculo é registrado uma única vez. O processamento é assíncrono." + parameters: + - name: companyId + in: path + description: ID da Empresa + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID (aggregate id) da NF-e original + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LinkCreditInvoiceRequestResource' + responses: + '202': + description: Vínculo enfileirado para processamento assíncrono + '400': + description: '`creditInvoiceId` ausente ou a Nota de Crédito não referencia esta NF-e' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: NF-e original ou Nota de Crédito não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/items: + get: + tags: + - Product Invoices + summary: Consultar os produtos por ID uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ Eletrônica (NFE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal Eletrônica que deverá ser retornada + required: true + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + - name: startingAfter + in: query + description: 'Índice de início do contador (Default: 0)' + schema: + type: integer + format: int32 + default: 0 + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/InvoiceItemsResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/events: + get: + tags: + - Product Invoices + summary: Consultar eventos por ID uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Nota Fiscal\ + \ Eletrônica (NFE) pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal Eletrônica que deverá ser retornada + required: true + schema: + type: string + - name: limit + in: query + description: 'Limite de resultados na página (Default: 10)' + schema: + type: integer + format: int32 + default: 10 + - name: startingAfter + in: query + description: 'Índice de início do contador (Default: 0)' + schema: + type: integer + format: int32 + responses: + '200': + description: Sucesso na consulta + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoiceEventsResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/pdf: + get: + tags: + - Product Invoices + summary: Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar a URL para o Documento\ + \ Auxiliar Nota Fiscal Eletrônica (DANFE)\r\nem formato de arquivo PDF." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + - name: force + in: query + description: Força a geração do pdf independente do FlowStatus + schema: + type: boolean + default: false + responses: + '200': + description: Sucesso na consulta do DANFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/xml: + get: + tags: + - Product Invoices + summary: Consultar XML da Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma nota fiscal\ + \ Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/xml/rejection: + get: + tags: + - Product Invoices + summary: Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar o motivo da rejeição de\ + \ uma nota fiscal Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/xml-rejection: + get: + tags: + - Product Invoices + summary: Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar o motivo da rejeição de\ + \ uma nota fiscal Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/xml-epec: + get: + tags: + - Product Invoices + summary: Consultar XML da autorização em contingência (EPEC) + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/correctionletter: + put: + tags: + - Product Invoices + summary: Enviar uma carta de correção para Nota Fiscal Eletrônica (CC-e) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma carta de correção na Nota\ + \ Fiscal Eletrônica (NFE).\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno\ + \ positivo\r\nnão garante a execução do documento fiscal.\r\nPara obter um retorno ao final do processo\ + \ de carta de correção de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser cancelada + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueueEventResource' + text/json: + schema: + $ref: '#/components/schemas/QueueEventResource' + application/*+json: + schema: + $ref: '#/components/schemas/QueueEventResource' + application/xml: + schema: + $ref: '#/components/schemas/QueueEventResource' + text/xml: + schema: + $ref: '#/components/schemas/QueueEventResource' + application/*+xml: + schema: + $ref: '#/components/schemas/QueueEventResource' + responses: + '204': + description: Sucesso ao enfileirar para cancelamento + content: + application/json: + schema: + $ref: '#/components/schemas/RequestCancellationResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/pdf: + get: + tags: + - Product Invoices + summary: Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) de Carta de Correção (CC-e) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar a URL para o Documento\ + \ Auxiliar Nota Fiscal Eletrônica (DANFE)\r\nem formato de arquivo PDF." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do DANFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/xml: + get: + tags: + - Product Invoices + summary: Consultar XML da Carta de Correção Eletrônica (CC-e) + description: "### Informações adicionais\r\nUtilize esta requisição para consultar os dados da carta de correção\ + \ de uma nota fiscal Eletrônica pelo ID." + parameters: + - name: companyId + in: path + description: ID da Empresa que deverá ser retornado + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser retornado + required: true + schema: + type: string + responses: + '200': + description: Sucesso na consulta do XML da NFE + content: + application/json: + schema: + $ref: '#/components/schemas/FileResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/{invoiceId}/disablement: + post: + tags: + - Product Invoices + summary: Inutilizar uma Nota Fiscal Eletrônica (NFE) + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica\ + \ (NFE) para fila de inutilização.\r\n**ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja,\ + \ o retorno positivo\r\nnão garante a inutilização do documento fiscal.\r\nPara obter um retorno ao final\ + \ do processo de inutilização de uma Nota Fiscal Eletrônica (NFe),\r\nrecomendamos utilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + - name: invoiceId + in: path + description: ID da Nota Fiscal que deverá ser inutilizada + required: true + schema: + type: string + - name: reason + in: query + description: Motivo da inutilização + schema: + type: string + responses: + '204': + description: Sucesso ao enfileirar para inutilização + content: + application/json: + schema: + $ref: '#/components/schemas/RequestCancellationResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/productinvoices/disablement: + post: + tags: + - Product Invoices + summary: Inutilizar números de nota fiscal + description: "### Informações adicionais\r\nCaso seja um único número, utilizar o Número inicial e o Número\ + \ final com o mesmo valor" + parameters: + - name: companyId + in: path + description: ID da Empresa + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisablementResource' + text/json: + schema: + $ref: '#/components/schemas/DisablementResource' + application/*+json: + schema: + $ref: '#/components/schemas/DisablementResource' + application/xml: + schema: + $ref: '#/components/schemas/DisablementResource' + text/xml: + schema: + $ref: '#/components/schemas/DisablementResource' + application/*+xml: + schema: + $ref: '#/components/schemas/DisablementResource' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/DisablementResource' + '400': + description: Algum parâmetro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '404': + description: Nota Fiscal Eletrônica não encontrada + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + /v3/companies/{companyId}/statetaxes/{statetaxId}/productinvoices: + post: + tags: + - Product Invoices + summary: Emitir uma Nota Fiscal Eletrônica (NFE) Informando um StateTaxId + description: "### Informações adicionais\r\nUtilize esta requisição para enviar uma Nota Fiscal Eletrônica\ + \ (NFE) para fila de emissão.\r\n**ATENÇÃO**: Cada processamento será feito de forma assíncrona, ou seja,\ + \ o retorno positivo\r\nnão garante a emissão do documento fiscal.\r\nPara obter um retorno ao final do\ + \ processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos\r\nutilizar os WebHooks." + parameters: + - name: companyId + in: path + description: Empresa ID + required: true + schema: + type: string + - name: statetaxId + in: path + description: Inscrição Estadual(StateTax) ID + required: true + schema: + type: string + requestBody: + description: Dados da nota fiscal a ser emitida + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + text/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/*+json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + text/xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + application/*+xml: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + responses: + '202': + description: Sucesso ao enfileirar para emissão + content: + application/json: + schema: + $ref: '#/components/schemas/ProductInvoiceQueueIssueResource' + '400': + description: Algum parametro informado não é válido, verificar resposta + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '408': + description: Tempo limite de 60s excedido no enfileiramento + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + '500': + description: Erro no processamento + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' +components: + schemas: + ActivityResource: + type: object + properties: + data: + description: Detalhes do Evento + nullable: true + type: + type: string + description: Nome do Evento gerado + nullable: true + sequence: + type: integer + description: Número sequencial do Evento + format: int32 + nullable: true + additionalProperties: false + AdditionResource: + type: object + properties: + code: + type: integer + description: Numero da adição (nAdicao) + format: int64 + nullable: true + manufacturer: + type: string + description: Código do fabricante estrangeiro (cFabricante) + nullable: true + amount: + type: number + description: Valor do desconto do item da DI – Adição (vDescDI) + format: double + nullable: true + drawback: + type: integer + description: Número do ato concessório de Drawback (nDraw) + format: int64 + nullable: true + additionalProperties: false + description: Adições (adi) + AdditionalInformationResource: + type: object + properties: + fisco: + type: string + description: Informações Adicionais de Interesse do Fisco (infAdFisco) + nullable: true + taxpayer: + type: string + description: Informações Complementares de interesse do Contribuinte (infCpl) + nullable: true + xmlAuthorized: + type: array + items: + type: integer + format: int64 + description: Informações Complementares de interesse do Contribuinte (infCpl) + nullable: true + effort: + type: string + nullable: true + order: + type: string + nullable: true + contract: + type: string + nullable: true + taxDocumentsReference: + type: array + items: + $ref: '#/components/schemas/TaxDocumentsReferenceResource' + description: Documentos Fiscais Referenciados (refECF) + nullable: true + taxpayerComments: + type: array + items: + $ref: '#/components/schemas/TaxpayerCommentsResource' + description: Observações fiscais (obsCont) + nullable: true + referencedProcess: + type: array + items: + $ref: '#/components/schemas/ReferencedProcessResource' + description: Processos referenciados (procRef) + nullable: true + additionalProperties: false + AddressResource: + type: object + required: + - state + - city + - district + - street + - number + properties: + state: + type: string + description: 'Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2.' + city: + $ref: '#/components/schemas/CityResource' + district: + type: string + description: Bairro do Endereço + additionalInformation: + type: string + description: 'Complemento do Endereço, ex.: AP 2, BL A.' + nullable: true + street: + type: string + description: Logradouro do Endereço + number: + type: string + description: Número do Endereço. Usar S/N para "sem número". + postalCode: + type: string + description: Cód. Endereço Postal (CEP) + nullable: true + country: + type: string + description: 'País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3.' + nullable: true + phone: + type: string + description: Telefone + nullable: true + additionalProperties: false + description: Dados do Endereço + AuthorizationResource: + type: object + properties: + receiptOn: + type: string + format: date-time + nullable: true + accessKey: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + BillResource: + type: object + properties: + number: + type: string + description: Número da Fatura (nFat) + nullable: true + originalAmount: + type: number + description: Valor Original da Fatura (vOrig) + format: double + nullable: true + discountAmount: + type: number + description: Valor do desconto (vDesc) + format: double + nullable: true + netAmount: + type: number + description: Valor Líquido da Fatura (vLiq) + format: double + nullable: true + additionalProperties: false + BillingResource: + type: object + properties: + bill: + $ref: '#/components/schemas/BillResource' + duplicates: + type: array + items: + $ref: '#/components/schemas/DuplicateResource' + description: Grupo Duplicata (dup) + nullable: true + additionalProperties: false + BuyerResource: + type: object + required: + - name + - federalTaxNumber + - address + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumberIndicator: + $ref: '#/components/schemas/ReceiverStateTaxIndicator' + tradeName: + type: string + description: Nome fantasia + nullable: true + taxRegime: + $ref: '#/components/schemas/TaxRegime' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de endereço do Destinatário da NF-e" + CIDEResource: + type: object + properties: + bc: + type: number + description: BC da CIDE (qBCProd) + format: double + nullable: true + rate: + type: number + description: Valor da alíquota da CIDE (vAliqProd) + format: double + nullable: true + cideAmount: + type: number + description: Valor da CIDE (vCIDE) + format: double + nullable: true + additionalProperties: false + CardResource: + type: object + properties: + federalTaxNumber: + type: string + description: CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) + nullable: true + flag: + $ref: '#/components/schemas/FlagCard' + authorization: + type: string + description: Número de autorização da operação cartão de crédito e/ou débito (cAut) + nullable: true + integrationPaymentType: + $ref: '#/components/schemas/IntegrationPaymentType' + federalTaxNumberRecipient: + type: string + description: CNPJ do beneficiário do pagamento (CNPJReceb) + nullable: true + idPaymentTerminal: + type: string + description: Identificador do terminal de pagamento (idTermPag) + nullable: true + additionalProperties: false + CityResource: + type: object + required: + - code + - name + properties: + code: + type: string + description: Cód. do Município, segundo o Tabela de Municípios do IBGE + name: + type: string + description: Nome do Município + additionalProperties: false + CofinsTaxResource: + type: object + properties: + cst: + type: string + description: Código de Situação Tributária da COFINS + nullable: true + baseTax: + type: number + description: Valor da Base de Cálculo da COFINS (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota da COFINS (em percentual) (pCOFINS) + format: double + nullable: true + amount: + type: number + description: Valor da COFINS (vCOFINS) + format: double + nullable: true + baseTaxProductQuantity: + type: number + description: Quantidade Vendida (qBCProd) + format: double + nullable: true + productRate: + type: number + description: Alíquota da COFINS (em reais) (vAliqProd) + format: double + nullable: true + additionalProperties: false + description: "Grupo do COFINS\r\n\r\nID: S01\r\nPai: M01\r\n\r\n Obs: Informar apenas um dos grupos S02,\ + \ S03, S04 ou S04\r\n com base valor atribuído ao campo S06 – CST do COFINS\r\n" + ConsumerPresenceType: + enum: + - None + - Presence + - Internet + - Telephone + - Delivery + - OthersNonPresenceOperation + type: string + description: 'Indicador de Presença do comprador no estabelecimento comercial no momento da operação (indPres). + + Valores possíveis: + + - `None` (0): Não se aplica (ex: nota fiscal complementar ou de ajuste) + + - `Presence` (1): Operação presencial + + - `Internet` (2): Operação não presencial, pela Internet + + - `Telephone` (3): Operação não presencial, Teleatendimento + + - `Delivery` (4): NFC-e em operação com entrega a domicílio + + - `OthersNonPresenceOperation` (9): Outros, operação não presencial + + ' + ConsumerType: + enum: + - FinalConsumer + - Normal + type: string + description: 'Indica operação com Consumidor final (indFinal). + + Valores possíveis: + + - `Normal` (0): Não é consumidor final (revenda, industrialização etc.) — padrão para CNPJ + + - `FinalConsumer` (1): Consumidor final — padrão para CPF/NIF + + ' + ContingencyDetails: + type: object + properties: + authorizer: + $ref: '#/components/schemas/StateTaxProcessingAuthorizer' + startedOn: + type: string + description: Data e hora do início da contingência + format: date-time + reason: + type: string + description: Justificativa da entrada em contingência + nullable: true + additionalProperties: false + DeliveryInformationResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: Identificação do Local de entrega (entrega) + Destination: + enum: + - None + - Internal_Operation + - Interstate_Operation + - International_Operation + type: string + description: 'Identificador de local de destino da operação (idDest). + + Valores possíveis: + + - `None` (0): Nenhum + + - `Internal_Operation` (1): Operação interna (mesma UF) + + - `Interstate_Operation` (2): Operação interestadual (UFs diferentes) + + - `International_Operation` (3): Operação com o exterior + + ' + DisablementResource: + type: object + properties: + environment: + $ref: '#/components/schemas/EnvironmentType' + serie: + type: integer + description: Série + format: int32 + state: + $ref: '#/components/schemas/StateCode' + beginNumber: + type: integer + description: Número inicial + format: int32 + lastNumber: + type: integer + description: Número final (usar o mesmo número inicial se for apenas um número) + format: int32 + reason: + type: string + description: Motivo da inutilização + nullable: true + additionalProperties: false + description: Dados para inutilizar números de nota fiscal + DocumentElectronicInvoiceResource: + type: object + properties: + accessKey: + type: string + description: Chave de Acesso (refNFe) + nullable: true + additionalProperties: false + DocumentInvoiceReferenceResource: + type: object + properties: + state: + type: number + description: Código da UF (cUF) + format: double + nullable: true + yearMonth: + type: string + description: Ano / Mês (AAMM) + nullable: true + federalTaxNumber: + type: string + description: CNPJ (CNPJ) + nullable: true + model: + type: string + description: Modelo (mod) + nullable: true + series: + type: string + description: Série (serie) + nullable: true + number: + type: string + description: Número (nNF) + nullable: true + additionalProperties: false + DuductionIndicator: + enum: + - NotDeduct + - Deduce + type: string + description: 'Indicador de intermediador/marketplace na operação (indIntermed). + + Valores possíveis: + + - `NotDeduct` (0): Operação sem intermediador (em site ou plataforma própria) + + - `Deduce` (1): Operação em site ou plataforma de terceiros (marketplace) + + ' + DuplicateResource: + type: object + properties: + number: + type: string + description: Número da Duplicata (nDup) + nullable: true + expirationOn: + type: string + description: Data de vencimento (dVenc) + format: date-time + nullable: true + amount: + type: number + description: Valor da duplicata (vDup) + format: double + nullable: true + additionalProperties: false + EconomicActivityResource: + type: object + properties: + type: + $ref: '#/components/schemas/EconomicActivityType' + code: + type: integer + description: Código da Atividade da Empresa + format: int32 + nullable: true + additionalProperties: false + EconomicActivityType: + enum: + - Main + - Secondary + type: string + description: 'Tipo da atividade econômica da empresa. + + Valores possíveis: + + - `Main`: Atividade principal (CNAE primário) + + - `Secondary`: Atividade secundária (CNAE secundário) + + ' + EnvironmentType: + enum: + - None + - Production + - Test + type: string + description: 'Ambiente de processamento da nota fiscal (tpAmb). + + Valores possíveis: + + - `None` (0): Nenhum + + - `Production` (1): Produção — emite nota com validade fiscal + + - `Test` (2): Homologação — emite nota apenas para testes, sem validade fiscal + + ' + ErrorResource: + type: object + properties: + code: + type: integer + format: int32 + nullable: true + message: + type: string + nullable: true + additionalProperties: false + ErrorsResource: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResource' + nullable: true + readOnly: true + additionalProperties: false + ExemptReason: + enum: + - Agriculture + - Others + - DevelopmentEntities + type: string + description: 'Motivo da desoneração do ICMS (motDesICMS). + + Valores possíveis: + + - `Agriculture` (3): Uso na agropecuária + + - `Others` (9): Outros + + - `DevelopmentEntities` (12): Órgão de fomento e desenvolvimento agropecuário + + ' + ExportDetailResource: + type: object + properties: + drawback: + type: string + description: Número do ato concessório de Drawback (nDraw) + nullable: true + hintInformation: + $ref: '#/components/schemas/ExportHintResource' + additionalProperties: false + ExportHintResource: + type: object + properties: + registryId: + type: string + description: Número do Registro de Exportação (nRE) + nullable: true + accessKey: + type: string + description: Chave de Acesso da NF-e recebida para exportação (chNFe) + nullable: true + quantity: + type: number + description: Quantidade do item realmente exportado (qExport) + format: double + nullable: true + additionalProperties: false + ExportResource: + type: object + properties: + state: + $ref: '#/components/schemas/StateCode' + office: + type: string + description: Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) + nullable: true + local: + type: string + description: Informações Complementares de interesse do Contribuinte (xLocDespacho) + nullable: true + additionalProperties: false + FileResource: + type: object + properties: + uri: + type: string + description: Endereço Absoluto URI para o arquivo + nullable: true + additionalProperties: false + description: Arquivo + FlagCard: + enum: + - None + - Visa + - Mastercard + - AmericanExpress + - Sorocred + - DinersClub + - Elo + - Hipercard + - Aura + - Cabal + - Alelo + - BanesCard + - CalCard + - Credz + - Discover + - GoodCard + - GreenCard + - Hiper + - JCB + - Mais + - MaxVan + - Policard + - RedeCompras + - Sodexo + - ValeCard + - Verocheque + - VR + - Ticket + - Other + type: string + description: 'Bandeira da operadora de cartão de crédito/débito (tBand). + + Valores possíveis: + + - `None` (00): Nenhuma + + - `Visa` (01): Visa + + - `Mastercard` (02): Mastercard + + - `AmericanExpress` (03): American Express + + - `Sorocred` (04): Sorocred + + - `DinersClub` (05): Diners Club + + - `Elo` (06): Elo + + - `Hipercard` (07): Hipercard + + - `Aura` (08): Aura + + - `Cabal` (09): Cabal + + - `Alelo` (10): Alelo + + - `BanesCard` (11): Banes Card + + - `CalCard` (12): Cal Card + + - `Credz` (13): Credz + + - `Discover` (14): Discover + + - `GoodCard` (15): Good Card + + - `GreenCard` (16): Green Card + + - `Hiper` (17): Hiper + + - `JCB` (18): JCB + + - `Mais` (19): Mais + + - `MaxVan` (20): MaxVan + + - `Policard` (21): Policard + + - `RedeCompras` (22): RedeCompras + + - `Sodexo` (23): Sodexo + + - `ValeCard` (24): ValeCard + + - `Verocheque` (25): Verocheque + + - `VR` (26): VR + + - `Ticket` (27): Ticket + + - `Other` (99): Outros + + ' + FuelOriginResource: + type: object + properties: + indImport: + type: integer + description: Indicador de importação (indImport) + format: int32 + nullable: true + cUFOrig: + type: integer + description: Código da UF (cUFOrig) + format: int32 + nullable: true + pOrig: + type: number + description: Percentual originário para a UF (pOrig) + format: double + nullable: true + additionalProperties: false + VehicleDetailResource: + type: object + description: Detalhamento de Veículos novos (veicProd) - grupo J01 + properties: + operationType: + type: integer + description: Tipo da Operação (tpOp). 0-Outros; 1-Venda concessionária; 2-Faturamento direto para consumidor + final; 3-Venda direta para grandes consumidores + format: int32 + enum: + - 0 + - 1 + - 2 + - 3 + nullable: true + chassis: + type: string + description: Chassi do veículo - VIN (chassi). 17 caracteres alfanuméricos + minLength: 17 + maxLength: 17 + pattern: ^[A-Z0-9]+$ + nullable: true + colorCode: + type: string + description: Cor do veículo - código de cada montadora (cCor) + maxLength: 4 + nullable: true + colorDescription: + type: string + description: Descrição da Cor (xCor) + maxLength: 40 + nullable: true + enginePower: + type: string + description: Potência máxima do motor em cavalo vapor - CV (pot) + maxLength: 4 + nullable: true + engineDisplacement: + type: string + description: Capacidade volumétrica do motor em centímetros cúbicos - CC (cilin) + maxLength: 4 + nullable: true + netWeight: + type: string + description: Peso Líquido (pesoL) + maxLength: 9 + nullable: true + grossWeight: + type: string + description: Peso Bruto (pesoB) + maxLength: 9 + nullable: true + serialNumber: + type: string + description: Serial - série (nSerie) + maxLength: 9 + nullable: true + fuelType: + type: string + description: 'Tipo de combustível - Tabela RENAVAM (tpComb). Ex: 01-Álcool; 02-Gasolina; 03-Diesel; 16-Álcool/Gas.; + 17-Gas./Álcool/GNV; 18-Gasolina/Elétrico' + maxLength: 2 + nullable: true + engineNumber: + type: string + description: Número do motor (nMotor) + maxLength: 21 + nullable: true + maximumTractionCapacity: + type: string + description: Capacidade Máxima de Tração em toneladas - 4 casas decimais (CMT) + maxLength: 9 + nullable: true + wheelBase: + type: string + description: Distância entre eixos (dist) + maxLength: 4 + nullable: true + modelYear: + type: integer + description: 'Ano Modelo de Fabricação (anoMod). Formato: 4 dígitos' + format: int32 + nullable: true + manufactureYear: + type: integer + description: 'Ano de Fabricação (anoFab). Formato: 4 dígitos' + format: int32 + nullable: true + paintType: + type: string + description: Tipo de pintura (tpPint) + maxLength: 1 + nullable: true + vehicleType: + type: string + description: Tipo de veículo - Tabela RENAVAM (tpVeic) + maxLength: 2 + nullable: true + vehicleSpecies: + type: integer + description: Espécie de veículo - Tabela RENAVAM (espVeic) + format: int32 + nullable: true + vinCondition: + type: string + description: Condição do VIN - chassi (VIN). R-Remarcado; N-Normal + enum: + - R + - N + nullable: true + vehicleCondition: + type: integer + description: Condição do veículo (condVeic). 1-Acabado; 2-Inacabado; 3-Semi-acabado + format: int32 + enum: + - 1 + - 2 + - 3 + nullable: true + brandModelCode: + type: string + description: Código Marca Modelo - Tabela RENAVAM (cMod) + maxLength: 6 + nullable: true + denatranColorCode: + type: string + description: Código da Cor DENATRAN (cCorDENATRAN). 01-AMARELO; 02-AZUL; 03-BEGE; 04-BRANCA; 05-CINZA; + 06-DOURADA; 07-GRENA; 08-LARANJA; 09-MARROM; 10-PRATA; 11-PRETA; 12-ROSA; 13-ROXA; 14-VERDE; 15-VERMELHA; + 16-FANTASIA + maxLength: 2 + nullable: true + seatingCapacity: + type: integer + description: Quantidade máxima de passageiros sentados, inclusive motorista (lota) + format: int32 + nullable: true + restrictionType: + type: integer + description: Restrição (tpRest). 0-Não há; 1-Alienação Fiduciária; 2-Arrendamento Mercantil; 3-Reserva + de Domínio; 4-Penhor de Veículos; 9-Outras + format: int32 + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 9 + nullable: true + additionalProperties: false + FuelResource: + type: object + properties: + codeANP: + type: string + description: Código de produto da ANP (cProdANP) + nullable: true + percentageNG: + type: number + description: Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) + format: double + nullable: true + descriptionANP: + type: string + description: Descrição do produto conforme ANP (descANP) + nullable: true + percentageGLP: + type: number + description: Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) + format: double + nullable: true + percentageNGn: + type: number + description: Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) + format: double + nullable: true + percentageGNi: + type: number + description: Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) + format: double + nullable: true + startingAmount: + type: number + description: Valor de partida (cProdANP=210203001) (vPart) + format: double + nullable: true + codif: + type: string + description: Código de autorização / registro do CODIF (CODIF) + nullable: true + amountTemp: + type: number + description: Quantidade de combustível faturada à temperatura ambiente (qTemp) + format: double + nullable: true + stateBuyer: + type: string + description: Sigla da UF de consumo (UFCons) + nullable: true + cide: + $ref: '#/components/schemas/CIDEResource' + pump: + $ref: '#/components/schemas/PumpResource' + fuelOrigin: + $ref: '#/components/schemas/FuelOriginResource' + additionalProperties: false + ICMSTotal: + type: object + properties: + baseTax: + type: number + description: Base de Cálculo do ICMS (vBC) + format: double + nullable: true + icmsAmount: + type: number + description: Valor Total do ICMS (vICMS) + format: double + nullable: true + icmsExemptAmount: + type: number + description: Valor ICMS Total desonerado (vICMSDeson) + format: double + nullable: true + stCalculationBasisAmount: + type: number + description: Base de Cálculo do ICMS Substituição Tributária (vBCST) + format: double + nullable: true + stAmount: + type: number + description: Valor Total do ICMS ST (vST) + format: double + nullable: true + productAmount: + type: number + description: Valor Total dos produtos e serviços (vProd) + format: double + freightAmount: + type: number + description: Valor Total do Frete (vFrete) + format: double + nullable: true + insuranceAmount: + type: number + description: Valor Total do Seguro (vSeg) + format: double + nullable: true + discountAmount: + type: number + description: Valor Total do Desconto (vDesc) + format: double + nullable: true + iiAmount: + type: number + description: Valor Total do Imposto de Importação (vII) + format: double + nullable: true + ipiAmount: + type: number + description: Valor Total do IPI (vIPI) + format: double + nullable: true + pisAmount: + type: number + description: Valor do PIS (vPIS) + format: double + nullable: true + cofinsAmount: + type: number + description: Valor do COFINS (vCOFINS) + format: double + nullable: true + othersAmount: + type: number + description: Outras Despesas acessórias (vOutro) + format: double + nullable: true + invoiceAmount: + type: number + description: Valor Total da NF-e (vNF) + format: double + fcpufDestinationAmount: + type: number + description: Valor Total ICMS FCP UF Destino + format: double + nullable: true + icmsufDestinationAmount: + type: number + description: Valor Total ICMS Interestadual UF Destino + format: double + nullable: true + icmsufSenderAmount: + type: number + description: Valor Total ICMS Interestadual UF Rem. + format: double + nullable: true + federalTaxesAmount: + type: number + description: Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) + format: double + fcpAmount: + type: number + description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + format: double + nullable: true + fcpstAmount: + type: number + description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + retido por substituição tributária. + format: double + nullable: true + fcpstRetAmount: + type: number + description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza (vFCP) retido anteriormente por substituição tributária. + format: double + nullable: true + ipiDevolAmount: + type: number + description: Valor total do IPI devolvido (vIPIDevol) + format: double + nullable: true + qBCMono: + type: number + format: double + nullable: true + vICMSMono: + type: number + description: Valor total do ICMS monofásico próprio (vICMSMono). + format: double + nullable: true + qBCMonoReten: + type: number + description: Valor total da quantidade tributada do ICMS monofásico sujeito a retenção (qBCMonoReten). + format: double + nullable: true + vICMSMonoReten: + type: number + description: Valor total da quantidade tributada do ICMS monofásico retido anteriormente(vICMSMonoReten) + format: double + nullable: true + qBCMonoRet: + type: number + description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + format: double + nullable: true + vICMSMonoRet: + type: number + description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + format: double + nullable: true + additionalProperties: false + description: "Manual Contribuinte v_5.00\r\nGrupo de Valores Totais referentes ao ICMS" + ICMSTotalResource: + type: object + properties: + baseTax: + type: number + description: Base de Cálculo do ICMS (vBC) + format: double + nullable: true + icmsAmount: + type: number + description: Valor Total do ICMS (vICMS) + format: double + nullable: true + icmsExemptAmount: + type: number + description: Valor ICMS Total desonerado (vICMSDeson) + format: double + nullable: true + stCalculationBasisAmount: + type: number + description: Base de Cálculo do ICMS Substituição Tributária (vBCST) + format: double + nullable: true + stAmount: + type: number + description: Valor Total do ICMS ST (vST) + format: double + nullable: true + productAmount: + type: number + description: Valor Total dos produtos e serviços (vProd) + format: double + nullable: true + freightAmount: + type: number + description: Valor Total do Frete (vFrete) + format: double + nullable: true + insuranceAmount: + type: number + description: Valor Total do Seguro (vSeg) + format: double + nullable: true + discountAmount: + type: number + description: Valor Total do Desconto (vDesc) + format: double + nullable: true + iiAmount: + type: number + description: Valor Total do Imposto de Importação (vII) + format: double + nullable: true + ipiAmount: + type: number + description: Valor Total do IPI (vIPI) + format: double + nullable: true + pisAmount: + type: number + description: Valor do PIS (vPIS) + format: double + nullable: true + cofinsAmount: + type: number + description: Valor do COFINS (vCOFINS) + format: double + nullable: true + othersAmount: + type: number + description: Outras Despesas acessórias (vOutro) + format: double + nullable: true + invoiceAmount: + type: number + description: Valor Total da NF-e (vNF) + format: double + nullable: true + fcpufDestinationAmount: + type: number + description: Valor Total ICMS FCP UF Destino (vFCPUFDest) + format: double + nullable: true + icmsufDestinationAmount: + type: number + description: Valor Total ICMS Interestadual UF Destino (vICMSUFDest) + format: double + nullable: true + icmsufSenderAmount: + type: number + description: Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) + format: double + nullable: true + federalTaxesAmount: + type: number + description: Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) + format: double + nullable: true + fcpAmount: + type: number + description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + format: double + nullable: true + fcpstAmount: + type: number + description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (vFCPST) + format: double + nullable: true + fcpstRetAmount: + type: number + description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + format: double + nullable: true + ipiDevolAmount: + type: number + description: Valor total do IPI devolvido (vIPIDevol) + format: double + nullable: true + qBCMono: + type: number + description: Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) + format: double + nullable: true + vICMSMono: + type: number + description: Valor total do ICMS monofásico próprio (vICMSMono) + format: double + nullable: true + qBCMonoReten: + type: number + description: Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) + format: double + nullable: true + vICMSMonoReten: + type: number + description: Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) + format: double + nullable: true + qBCMonoRet: + type: number + description: Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) + format: double + nullable: true + vICMSMonoRet: + type: number + description: Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + format: double + nullable: true + additionalProperties: false + description: "Manual Contribuinte v_5.00\r\nGrupo de Valores Totais referentes ao ICMS" + ICMSUFDestinationTaxResource: + type: object + properties: + vBCUFDest: + type: number + description: Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) + format: double + nullable: true + pFCPUFDest: + type: number + description: Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de + Combate à Pobreza (FCP) naquela UF (pFCPUFDest) + format: double + nullable: true + pICMSUFDest: + type: number + description: Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) + format: double + nullable: true + pICMSInter: + type: number + description: Alíquota interestadual das UF envolvidas (pICMSInter) + format: double + nullable: true + pICMSInterPart: + type: number + description: Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) + format: double + nullable: true + vFCPUFDest: + type: number + description: Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest + format: double + nullable: true + vICMSUFDest: + type: number + description: Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) + format: double + nullable: true + vICMSUFRemet: + type: number + description: Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) + format: double + nullable: true + vBCFCPUFDest: + type: number + description: Valor da BC FCP na UF de destino (vBCFCPUFDest) + format: double + nullable: true + additionalProperties: false + description: Grupo de Tributação do ICMS de Destino da UF + IITaxResource: + type: object + properties: + baseTax: + type: string + description: Valor BC do Imposto de Importação (vBC) + nullable: true + customsExpenditureAmount: + type: string + description: Valor despesas aduaneiras (vDespAdu) + nullable: true + amount: + type: number + description: Valor Imposto de Importação (vII) + format: double + nullable: true + iofAmount: + type: number + description: Valor Imposto sobre Operações Financeiras (vIOF) + format: double + nullable: true + vEnqCamb: + type: number + description: Valor dos encargos cambiais + format: double + nullable: true + additionalProperties: false + description: "Grupo do Imposto de Importação\r\n\r\nId: P01\r\nPai: O01" + IPITaxResource: + type: object + properties: + cst: + type: string + description: Código da situação tributária do IPI (CST) + nullable: true + classificationCode: + type: string + description: Código de Enquadramento Legal do IPI (cEnq) + nullable: true + classification: + type: string + description: "clEnq\r\nClasse de enquadramento do IPI para Cigarros e Bebidas (clEnq)" + nullable: true + producerCNPJ: + type: string + description: CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação + direta ou indireta (CNPJProd) + nullable: true + stampCode: + type: string + description: Código do selo de controle IPI (cSelo) + nullable: true + stampQuantity: + type: number + description: Quantidade de selo de controle (qSelo) + format: double + nullable: true + base: + type: number + description: Valor da BC do IPI (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota do IPI (pIPI) + format: double + nullable: true + unitQuantity: + type: number + description: Quantidade total na unidade padrão para tributação (somente para os produtos tributados por + unidade) (qUnid) + format: double + nullable: true + unitAmount: + type: number + description: Valor por Unidade Tributável (vUnid) + format: double + nullable: true + amount: + type: number + description: Valor IPI (vIPI) + format: double + nullable: true + additionalProperties: false + description: "\r\nGrupo do IPI\r\n\r\nInformar apenas quando o item for sujeito ao IPI\r\n\r\nID: O01\r\n\r\ + \nPai: M01" + ISSQNTotal: + type: object + properties: + totalServiceNotTaxedICMS: + type: number + description: Valor Total Serv.Não Tributados p/ ICMS + format: double + nullable: true + baseRateISS: + type: number + description: Base de Cálculo do ISS + format: double + nullable: true + totalISS: + type: number + description: Valor Total do ISS + format: double + nullable: true + valueServicePIS: + type: number + description: Valor do PIS sobre Serviços + format: double + nullable: true + valueServiceCOFINS: + type: number + description: Valor da COFINS sobre Serviços + format: double + nullable: true + provisionService: + type: string + description: Data Prestação Serviço + format: date-time + nullable: true + deductionReductionBC: + type: number + description: Valor Dedução para Redução da BC + format: double + nullable: true + valueOtherRetention: + type: number + description: Valor Outras Retenções + format: double + nullable: true + discountUnconditional: + type: number + description: Valor Desconto Incondicionado + format: double + nullable: true + discountConditioning: + type: number + description: Valor Desconto Condicionado + format: double + nullable: true + totalRetentionISS: + type: number + description: Valor Total Retenção ISS + format: double + nullable: true + codeTaxRegime: + type: number + description: Código Regime Tributação + format: double + nullable: true + additionalProperties: false + ISSQNTotalResource: + type: object + properties: + totalServiceNotTaxedICMS: + type: number + description: Valor Total Serv.Não Tributados p/ ICMS (vServ) + format: double + nullable: true + baseRateISS: + type: number + description: Base de Cálculo do ISS (vBC) + format: double + nullable: true + totalISS: + type: number + description: Valor Total do ISS (vISS) + format: double + nullable: true + valueServicePIS: + type: number + description: Valor do PIS sobre Serviços (vPIS) + format: double + nullable: true + valueServiceCOFINS: + type: number + description: Valor da COFINS sobre Serviços (vCOFINS) + format: double + nullable: true + provisionService: + type: string + description: Data Prestação Serviço (dCompet) + format: date-time + nullable: true + deductionReductionBC: + type: number + description: Valor Dedução para Redução da BC (vDeducao) + format: double + nullable: true + valueOtherRetention: + type: number + description: Valor Outras Retenções (vOutro) + format: double + nullable: true + discountUnconditional: + type: number + description: Valor Desconto Incondicionado (vDescIncond) + format: double + nullable: true + discountConditioning: + type: number + description: Valor Desconto Condicionado (vDescCond) + format: double + nullable: true + totalRetentionISS: + type: number + description: Valor Total Retenção ISS (vISSRet) + format: double + nullable: true + codeTaxRegime: + type: number + description: Código Regime Tributação (cRegTrib) + format: double + nullable: true + additionalProperties: false + IcmsTaxResource: + type: object + description: 'Grupo do ICMS da Operação própria e ST (ICMS). + + **Regra de obrigatoriedade**: deve-se informar **exatamente um** entre `cst` (Regime Normal) ou `csosn` + (Simples Nacional). A SEFAZ não aceita ambos preenchidos ou nenhum dos dois. + + ' + required: + - origin + properties: + origin: + type: string + description: Origem da mercadoria (orig) + cst: + type: string + description: Tributação do ICMS (CST) — obrigatório quando o emitente é do Regime Normal. Mutuamente exclusivo + com `csosn`. + nullable: true + csosn: + type: string + description: "101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN)\r\nCódigo\ + \ de Situação da Operação – Simples Nacional" + nullable: true + baseTaxModality: + type: string + description: "Modalidade de determinação da BC do ICMS (modBC)\r\n\r\n Margem Valor Agregado\ + \ (%) = 0\r\n Pauta (valor) = 1\r\n Preço Tabelado Máximo (valor) = 2\r\n Valor da Operação\ + \ = 3\r\n" + nullable: true + baseTax: + type: number + description: Valor da BC do ICMS (vBC) + format: double + nullable: true + baseTaxSTModality: + type: string + description: Modalidade de determinação da BC do ICMS ST (modBCST) + nullable: true + baseTaxSTReduction: + type: string + description: "pRedBCST\r\nPercentual da Redução de BC do ICMS ST (pRedBCST)" + nullable: true + baseTaxST: + type: number + description: Valor da BC do ICMS ST (vBCST) + format: double + nullable: true + baseTaxReduction: + type: number + description: Percentual da Redução de BC (pRedBC) + format: double + nullable: true + stRate: + type: number + description: Alíquota do imposto do ICMS ST (pICMSST) + format: double + nullable: true + stAmount: + type: number + description: Valor do ICMS ST (vICMSST) + format: double + nullable: true + stMarginAmount: + type: number + description: "pMVAST\r\nPercentual da margem de valor Adicionado do ICMS ST (pMVAST)" + format: double + nullable: true + rate: + type: number + description: "pICMS\r\nAlíquota do imposto (pICMS)" + format: double + nullable: true + amount: + type: number + description: "Valor do ICMS (vICMS)\r\nO valor do ICMS desonerado será informado apenas nas operações:\r\ + \na) com produtos beneficiados com a desoneração condicional do ICMS.\r\nb) destinadas à SUFRAMA, informando-se\ + \ o valor que seria devido se não houvesse isenção.\r\nc) de venda a órgãos da administração pública\ + \ direta e suas fundações e\r\nautarquias com isenção do ICMS. (NT 2011/004)" + format: double + nullable: true + percentual: + type: number + description: Percentual da Redução de BC (pICMS) + format: double + nullable: true + snCreditRate: + type: number + description: Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) + format: double + nullable: true + snCreditAmount: + type: number + description: Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional + (vCredICMSSN) + format: double + nullable: true + stMarginAddedAmount: + type: string + description: Percentual da margem de valor Adicionado do ICMS ST (pMVAST) + nullable: true + stRetentionAmount: + type: string + description: Valor do ICMS ST retido (vICMSSTRet) + nullable: true + baseSTRetentionAmount: + type: string + description: Valor da BC do ICMS ST retido (vBCSTRet) + nullable: true + baseTaxOperationPercentual: + type: string + description: "Percentual da BC operação própria (pBCOp)\r\nPercentual para determinação do valor da\ + \ Base de Cálculo da operação própria. (v2.0)" + nullable: true + ufst: + type: string + description: "UF para qual é devido o ICMS ST (UFST)\r\nSigla da UF para qual é devido o ICMS ST da operação.\ + \ (v2.0)" + nullable: true + amountSTReason: + type: string + description: Motivo Desoneração ICMS + nullable: true + baseSNRetentionAmount: + type: string + description: Valor da BC do ICMS ST retido (vBCSTRet) + nullable: true + snRetentionAmount: + type: string + description: Valor do ICMS ST retido (vICMSSTRet) + nullable: true + amountOperation: + type: string + description: Valor do ICMS da Operação (vICMSOp) + nullable: true + percentualDeferment: + type: string + description: Percentual do Diferimento (pDif) + nullable: true + baseDeferred: + type: string + description: Valor do ICMS Diferido (vICMSDif) + nullable: true + exemptAmount: + type: number + description: Valor ICMS Desonerado + format: double + nullable: true + exemptReason: + $ref: '#/components/schemas/ExemptReason' + exemptAmountST: + type: number + description: Valor ICMS Desonerado + format: double + nullable: true + exemptReasonST: + $ref: '#/components/schemas/ExemptReason' + fcpRate: + type: number + description: Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) + format: double + nullable: true + fcpAmount: + type: number + description: Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + format: double + nullable: true + fcpstRate: + type: number + description: Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (pFCPST) + format: double + nullable: true + fcpstAmount: + type: number + description: Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido + por substituição tributária (vFCPST) + format: double + nullable: true + fcpstRetRate: + type: number + description: Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) + format: double + nullable: true + fcpstRetAmount: + type: number + description: Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate + à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + format: double + nullable: true + baseTaxFCPSTAmount: + type: number + description: Informar o valor da Base de Cálculo do FCP (vBCFCPST) + format: double + nullable: true + substituteAmount: + type: number + description: 'Valor do ICMS próprio do Substituto (tag: vICMSSubstituto)' + format: double + nullable: true + stFinalConsumerRate: + type: number + description: "N26a - Alíquota suportada pelo Consumidor Final (pST)\r\nDeve ser informada a alíquota do\ + \ cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria" + format: double + nullable: true + effectiveBaseTaxReductionRate: + type: number + description: N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime + comum de tributação (pRedBCEfet) + format: double + nullable: true + effectiveBaseTaxAmount: + type: number + description: N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação + (vBCEfet) + format: double + nullable: true + effectiveRate: + type: number + description: N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) + format: double + nullable: true + effectiveAmount: + type: number + description: N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) + format: double + nullable: true + deductionIndicator: + $ref: '#/components/schemas/DuductionIndicator' + additionalProperties: false + ImportDeclarationResource: + type: object + properties: + code: + type: string + description: Número do Documento de Importação da DI/DSI/DA (nDI) + nullable: true + registeredOn: + type: string + description: Data de Registro da DI/DSI/DA (dDI) + format: date-time + nullable: true + customsClearanceName: + type: string + description: Local de desembaraço (xLocDesemb) + nullable: true + customsClearanceState: + $ref: '#/components/schemas/StateCode' + customsClearancedOn: + type: string + description: Data do Desembaraço Aduaneiro (dDesemb) + format: date-time + nullable: true + additions: + type: array + items: + $ref: '#/components/schemas/AdditionResource' + description: Adições (adi) + nullable: true + exporter: + type: string + description: Código do exportador (cExportador) + nullable: true + internationalTransport: + $ref: '#/components/schemas/InternationalTransportType' + intermediation: + $ref: '#/components/schemas/IntermediationType' + acquirerFederalTaxNumber: + type: string + description: CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) + nullable: true + stateThird: + type: string + description: Sigla da UF do adquirente ou do encomendante (UFTerceiro) + nullable: true + additionalProperties: false + description: Declaração Importação (DI) + IntegrationPaymentType: + enum: + - Integrated + - NotIntegrated + type: string + description: "1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio\ + \ Eletrônico)\r\n2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS);" + IntermediateResource: + type: object + properties: + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + identifier: + type: string + description: Identificador cadastrado no intermediador (idCadIntTran) + nullable: true + additionalProperties: false + description: Grupo de Informações do Intermediador da Transação (infIntermed) + IntermediationType: + enum: + - None + - ByOwn + - ImportOnBehalf + - ByOrder + type: string + description: 'Tipo de Intermediação na operação de importação (tpIntermedio). + + Valores possíveis: + + - `None` (0): Nenhum + + - `ByOwn` (1): Importação por conta própria + + - `ImportOnBehalf` (2): Importação por conta e ordem + + - `ByOrder` (3): Importação por encomenda + + ' + InternationalTransportType: + enum: + - None + - Maritime + - River + - Lake + - Airline + - Postal + - Railway + - Highway + - Network + - Own + - Ficta + - Courier + - Handcarry + type: string + description: 'Tipo de Transporte Internacional (tpViaTransp). + + Valores possíveis: + + - `None` (0): Nenhum + + - `Maritime` (1): Marítima + + - `River` (2): Fluvial + + - `Lake` (3): Lacustre + + - `Airline` (4): Aérea + + - `Postal` (5): Postal + + - `Railway` (6): Ferroviária + + - `Highway` (7): Rodoviária + + - `Network` (8): Conduto / Rede de Transmissão + + - `Own` (9): Meios Próprios + + - `Ficta` (10): Entrada / Saída ficta + + - `Courier` (11): Courier + + - `Handcarry` (12): Handcarry + + ' + InvoiceEventsResourceBase: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/ActivityResource' + description: Lista de Eventos ocorridos na Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + nullable: true + additionalProperties: false + InvoiceItemResource: + type: object + required: + - code + - description + - ncm + - unit + - unitTax + - quantity + - unitAmount + - totalAmount + - tax + properties: + code: + type: string + description: Código do produto ou serviço (cProd) + codeGTIN: + type: string + description: "GTIN (Global Trade Item Number) do produto,\r\nantigo código EAN ou código de barras (cEAN)" + nullable: true + description: + type: string + description: Descrição do produto ou serviço (xProd) + ncm: + type: string + description: Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) + nve: + type: array + items: + type: string + description: Nomenclatura de Valor aduaneiro e Estatístico (NVE) + nullable: true + extipi: + type: string + description: Código Exceção da Tabela de IPI + nullable: true + cfop: + type: integer + description: Código Fiscal de Operações e Prestações (CFOP) + format: int64 + nullable: true + unit: + type: string + description: Unidade Comercial (uCom) + quantity: + type: number + description: Quantidade Comercial (qCom) + format: double + unitAmount: + type: number + description: Valor Unitário de Comercialização (vUnCom) + format: double + totalAmount: + type: number + description: Valor Total Bruto dos Produtos ou Serviços (vProd) + format: double + codeTaxGTIN: + type: string + description: "GTIN (Global Trade Item Number) da unidade tributável,\r\nantigo código EAN ou código de\ + \ barras (cEANTrib)" + nullable: true + unitTax: + type: string + description: Unidade Tributável (uTrib) + quantityTax: + type: number + description: Quantidade Tributável (qTrib) + format: double + nullable: true + taxUnitAmount: + type: number + description: Valor Unitário de tributação (vUnTrib) + format: double + nullable: true + freightAmount: + type: number + description: Valor Total do Frete (vFrete) + format: double + nullable: true + insuranceAmount: + type: number + description: Valor Total do Seguro (vSeg) + format: double + nullable: true + discountAmount: + type: number + description: Valor do Desconto (vDesc) + format: double + nullable: true + othersAmount: + type: number + description: Outras despesas acessórias (vOutro) + format: double + nullable: true + totalIndicator: + type: boolean + description: "Indica se valor do Item (vProd)\r\nentra no valor total da NF-e (vProd) (indTot)" + nullable: true + cest: + type: string + description: CEST - Código especificador da substituição tributária + nullable: true + tax: + $ref: '#/components/schemas/InvoiceItemTaxResource' + additionalInformation: + type: string + description: Informações Adicionais do Produto (infAdProd) + nullable: true + numberOrderBuy: + type: string + description: Número do pedido de compra (xPed) + nullable: true + itemNumberOrderBuy: + type: integer + description: Item do Pedido de Compra (nItemPed) + format: int32 + nullable: true + importControlSheetNumber: + type: string + description: Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) + nullable: true + vehicleDetail: + $ref: '#/components/schemas/VehicleDetailResource' + fuelDetail: + $ref: '#/components/schemas/FuelResource' + benefit: + type: string + description: Código de Benefício Fiscal na UF aplicado ao item (cBenef) + nullable: true + importDeclarations: + type: array + items: + $ref: '#/components/schemas/ImportDeclarationResource' + description: Declaração Importação (DI) + nullable: true + exportDetails: + type: array + items: + $ref: '#/components/schemas/ExportDetailResource' + description: Grupo de informações de exportação para o item (detExport) + nullable: true + taxDetermination: + $ref: '#/components/schemas/TaxDeterminationResource' + additionalProperties: false + description: "Manual Contribuinte v_5.00\r\nGrupo do detalhamento de Produtos e Serviços da NF-e" + InvoiceItemTaxResource: + type: object + required: + - icms + properties: + totalTax: + type: number + description: Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) + format: double + nullable: true + icms: + $ref: '#/components/schemas/IcmsTaxResource' + ipi: + $ref: '#/components/schemas/IPITaxResource' + ii: + $ref: '#/components/schemas/IITaxResource' + pis: + $ref: '#/components/schemas/PISTaxResource' + cofins: + $ref: '#/components/schemas/CofinsTaxResource' + icmsDestination: + $ref: '#/components/schemas/ICMSUFDestinationTaxResource' + additionalProperties: false + InvoiceItemsResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + companyId: + type: string + description: Identificador da Empresa + nullable: true + id: + type: string + description: Identificador da Nota Fiscal + nullable: true + items: + type: array + items: + $ref: '#/components/schemas/InvoiceItemResource' + description: Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identifica se existem mais items a serem consultados + nullable: true + additionalProperties: false + InvoiceResource: + type: object + properties: + id: + type: string + description: Identificador único + nullable: true + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + status: + $ref: '#/components/schemas/InvoiceStatus' + authorization: + $ref: '#/components/schemas/AuthorizationResource' + contingencyDetails: + $ref: '#/components/schemas/ContingencyDetails' + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + createdOn: + type: string + description: Data de criação + format: date-time + nullable: true + modifiedOn: + type: string + description: Data de modificação + format: date-time + nullable: true + operationOn: + type: string + description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n \ + \ Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + environmentType: + $ref: '#/components/schemas/EnvironmentType' + purposeType: + $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' + creditInvoicesIssuedAgainst: + type: array + nullable: true + description: 'Lista de Notas de Crédito por recusa que referenciaram esta NF-e. `null` + quando a NF-e nunca foi referenciada. Populada pela projeção do evento + `CreditInvoiceIssuedAgainst` no read-model.' + items: + $ref: '#/components/schemas/CreditInvoiceReferenceResource' + issuer: + $ref: '#/components/schemas/IssuerResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + totals: + $ref: '#/components/schemas/TotalResource' + transport: + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + export: + $ref: '#/components/schemas/ExportResource' + billing: + $ref: '#/components/schemas/BillingResource' + payment: + type: array + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag) + nullable: true + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + delivery: + $ref: '#/components/schemas/DeliveryInformationResource' + withdrawal: + $ref: '#/components/schemas/WithdrawalInformationResource' + lastEvents: + $ref: '#/components/schemas/InvoiceEventsResourceBase' + additionalProperties: false + InvoiceStatus: + enum: + - None + - Created + - Processing + - Issued + - IssuedContingency + - Cancelled + - Disabled + - IssueDenied + - Error + type: string + description: 'Status atual da nota fiscal na plataforma. + + Valores possíveis: + + - `IssueDenied` (-2): Emissão denegada pela SEFAZ + + - `Error` (-1): Erro de processamento + + - `None` (0): Nenhum status definido + + - `Created` (1): Criada (registrada na plataforma, ainda não enviada) + + - `Processing` (2): Em processamento + + - `Issued` (3): Emitida com sucesso (autorizada pela SEFAZ) + + - `IssuedContingency` (4): Emitida em contingência (aguardando sincronização) + + - `Cancelled` (5): Cancelada + + - `Disabled` (6): Inutilizada + + ' + InvoiceWithoutEventsResource: + type: object + properties: + id: + type: string + description: Identificador único + nullable: true + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + status: + $ref: '#/components/schemas/InvoiceStatus' + authorization: + $ref: '#/components/schemas/AuthorizationResource' + contingencyDetails: + $ref: '#/components/schemas/ContingencyDetails' + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + createdOn: + type: string + description: Data de criação + format: date-time + nullable: true + modifiedOn: + type: string + description: Data de modificação + format: date-time + nullable: true + operationOn: + type: string + description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n \ + \ Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + environmentType: + $ref: '#/components/schemas/EnvironmentType' + purposeType: + $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' + creditInvoicesIssuedAgainst: + type: array + nullable: true + description: 'Lista de Notas de Crédito por recusa que referenciaram esta NF-e. `null` + quando a NF-e nunca foi referenciada. Populada pela projeção do evento + `CreditInvoiceIssuedAgainst` no read-model.' + items: + $ref: '#/components/schemas/CreditInvoiceReferenceResource' + issuer: + $ref: '#/components/schemas/IssuerResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + totals: + $ref: '#/components/schemas/TotalResource' + transport: + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + export: + $ref: '#/components/schemas/ExportResource' + billing: + $ref: '#/components/schemas/BillingResource' + payment: + type: array + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag) + nullable: true + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + delivery: + $ref: '#/components/schemas/DeliveryInformationResource' + withdrawal: + $ref: '#/components/schemas/WithdrawalInformationResource' + additionalProperties: false + IssuerFromRequestResource: + type: object + properties: + stStateTaxNumber: + type: string + description: IE do Substituto Tributário (IEST) + nullable: true + additionalProperties: false + IssuerResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + tradeName: + type: string + description: Nome Fantasia + nullable: true + openningDate: + type: string + description: Data abertura da empresa + format: date-time + nullable: true + taxRegime: + $ref: '#/components/schemas/TaxRegime' + specialTaxRegime: + $ref: '#/components/schemas/SpecialTaxRegime' + legalNature: + $ref: '#/components/schemas/LegalNature' + economicActivities: + type: array + items: + $ref: '#/components/schemas/EconomicActivityResource' + description: Atividades da Empresa (CNAE) + nullable: true + companyRegistryNumber: + type: integer + description: Número de Inscrição na Junta Comercial + format: int64 + nullable: true + regionalTaxNumber: + type: integer + description: Número de Inscrição na SEFAZ (IE) + format: int64 + nullable: true + regionalSTTaxNumber: + type: integer + description: Inscrição Estadual do Substituto Tributário (IEST) + format: int64 + nullable: true + municipalTaxNumber: + type: string + description: Número de Inscrição na Prefeitura (IM/CCM) + nullable: true + stStateTaxNumber: + type: string + description: IE do Substituto Tributário (IEST) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de identificação do emitente da NF-e" + LegalNature: + enum: + - EmpresaPublica + - SociedadeEconomiaMista + - SociedadeAnonimaAberta + - SociedadeAnonimaFechada + - SociedadeEmpresariaLimitada + - SociedadeEmpresariaEmNomeColetivo + - SociedadeEmpresariaEmComanditaSimples + - SociedadeEmpresariaEmComanditaporAcoes + - SociedadeemContaParticipacao + - Empresario + - Cooperativa + - ConsorcioSociedades + - GrupoSociedades + - EmpresaDomiciliadaExterior + - ClubeFundoInvestimento + - SociedadeSimplesPura + - SociedadeSimplesLimitada + - SociedadeSimplesEmNomeColetivo + - SociedadeSimplesEmComanditaSimples + - EmpresaBinacional + - ConsorcioEmpregadores + - ConsorcioSimples + - EireliNaturezaEmpresaria + - EireliNaturezaSimples + - ServicoNotarial + - FundacaoPrivada + - ServicoSocialAutonomo + - CondominioEdilicio + - ComissaoConciliacaoPrevia + - EntidadeMediacaoArbitragem + - PartidoPolitico + - EntidadeSindical + - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras + - FundacaoAssociacaoDomiciliadaExterior + - OrganizacaoReligiosa + - ComunidadeIndigena + - FundoPrivado + - AssociacaoPrivada + type: string + description: 'Código da Natureza Jurídica da empresa, conforme tabela do IBGE. + + Valores possíveis (não exaustivo, 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) + + - `SociedadeEmpresariaEmNomeColetivo`: Sociedade Empresária em Nome Coletivo + + - `SociedadeEmpresariaEmComanditaSimples`: Sociedade Empresária em Comandita Simples + + - `SociedadeEmpresariaEmComanditaporAcoes`: Sociedade Empresária em Comandita por Ações + + - `SociedadeemContaParticipacao`: Sociedade em Conta de Participação + + - `Empresario`: Empresário (Empresário Individual) + + - `Cooperativa`: Cooperativa + + - `ConsorcioSociedades`: Consórcio de Sociedades + + - `GrupoSociedades`: Grupo de Sociedades + + - `EmpresaDomiciliadaExterior`: Empresa Domiciliada no Exterior + + - `ClubeFundoInvestimento`: Clube/Fundo de Investimento + + - `SociedadeSimplesPura`: Sociedade Simples Pura + + - `SociedadeSimplesLimitada`: Sociedade Simples Limitada + + - `SociedadeSimplesEmNomeColetivo`: Sociedade Simples em Nome Coletivo + + - `SociedadeSimplesEmComanditaSimples`: Sociedade Simples em Comandita Simples + + - `EmpresaBinacional`: Empresa Binacional + + - `ConsorcioEmpregadores`: Consórcio de Empregadores + + - `ConsorcioSimples`: Consórcio Simples + + - `EireliNaturezaEmpresaria`: EIRELI de Natureza Empresária + + - `EireliNaturezaSimples`: EIRELI de Natureza Simples + + - `ServicoNotarial`: Serviço Notarial e Registral (Cartórios) + + - `FundacaoPrivada`: Fundação Privada + + - `ServicoSocialAutonomo`: Serviço Social Autônomo + + - `CondominioEdilicio`: Condomínio Edilício + + - `ComissaoConciliacaoPrevia`: Comissão de Conciliação Prévia + + - `EntidadeMediacaoArbitragem`: Entidade de Mediação e Arbitragem + + - `PartidoPolitico`: Partido Político + + - `EntidadeSindical`: Entidade Sindical + + - `EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras`: Estabelecimento no Brasil de Fundação ou Associação + Estrangeiras + + - `FundacaoAssociacaoDomiciliadaExterior`: Fundação/Associação Domiciliada no Exterior + + - `OrganizacaoReligiosa`: Organização Religiosa + + - `ComunidadeIndigena`: Comunidade Indígena + + - `FundoPrivado`: Fundo Privado + + - `AssociacaoPrivada`: Associação Privada + + ' + OperationType: + enum: + - Outgoing + - Incoming + type: string + description: 'Tipo da Operação fiscal (tpNF). + + Valores possíveis: + + - `Outgoing` (1): Saída — operação em que a mercadoria sai do estabelecimento (ex: venda) + + - `Incoming` (0): Entrada — operação em que a mercadoria entra no estabelecimento (ex: devolução) + + ' + PISTaxResource: + type: object + properties: + cst: + type: string + description: Código de Situação Tributária do PIS (CST) + nullable: true + baseTax: + type: number + description: Valor da Base de Cálculo do PIS (vBC) + format: double + nullable: true + rate: + type: number + description: Alíquota do PIS (em percentual) (pPIS) + format: double + nullable: true + amount: + type: number + description: Valor do PIS (vPIS) + format: double + nullable: true + baseTaxProductQuantity: + type: number + description: Quantidade Vendida (qBCProd) + format: double + nullable: true + productRate: + type: number + description: Alíquota do PIS (em reais) (vAliqProd) + format: double + nullable: true + additionalProperties: false + description: Grupo do PIS + PaymentDetailResource: + type: object + required: + - method + properties: + method: + $ref: '#/components/schemas/PaymentMethod' + methodDescription: + type: string + description: Descrição do meio de pagamento (xPag) + nullable: true + paymentType: + $ref: '#/components/schemas/PaymentType' + amount: + type: number + description: Valor do Pagamento (vPag). Obrigatório para todos os meios exceto `method = WithoutPayment` + (tPag=90), em que pode ser omitido. + format: double + nullable: true + card: + $ref: '#/components/schemas/CardResource' + paymentDate: + type: string + description: Data do pagamento (dPag) + format: date-time + nullable: true + federalTaxNumberPag: + type: string + description: CNPJ transacional do pagamento (CNPJPag) + nullable: true + statePag: + type: string + description: UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) + nullable: true + additionalProperties: false + PaymentMethod: + enum: + - Cash + - Cheque + - CreditCard + - DebitCard + - StoreCredict + - FoodVouchers + - MealVouchers + - GiftVouchers + - FuelVouchers + - BankBill + - BankDeposit + - InstantPayment + - WireTransfer + - Cashback + - WithoutPayment + - Others + type: string + description: 'Meio de pagamento (tPag). + + Valores possíveis: + + - `Cash` (01): Dinheiro + + - `Cheque` (02): Cheque + + - `CreditCard` (03): Cartão de Crédito + + - `DebitCard` (04): Cartão de Débito + + - `StoreCredict` (05): Crédito Loja + + - `FoodVouchers` (10): Vale Alimentação + + - `MealVouchers` (11): Vale Refeição + + - `GiftVouchers` (12): Vale Presente + + - `FuelVouchers` (13): Vale Combustível + + - `BankBill` (15): Boleto Bancário + + - `BankDeposit` (16): Depósito Bancário + + - `InstantPayment` (17): Pagamento Instantâneo (PIX) Dinâmico + + - `WireTransfer` (18): Transferência bancária, Carteira Digital + + - `Cashback` (19): Programa de fidelidade, Cashback, Crédito Virtual + + - `WithoutPayment` (90): Sem Pagamento + + - `Others` (99): Outros + + ' + PaymentResource: + type: object + required: + - paymentDetail + properties: + paymentDetail: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/PaymentDetailResource' + description: "YA01a - Grupo Detalhamento da Forma de Pagamento (detPag)\r\nVERSÃO 4.00" + payBack: + type: number + description: "Valor do troco (vTroco)\r\nVERSÃO 4.00" + format: double + nullable: true + additionalProperties: false + PaymentType: + enum: + - InCash + - Term + type: string + description: 'Indicador da forma de pagamento (indPag). + + Valores possíveis: + + - `InCash` (0): À vista + + - `Term` (1): A prazo + + ' + PersonType: + enum: + - Undefined + - NaturalPerson + - LegalEntity + - Company + - Customer + type: string + description: 'Tipo de pessoa. + + Valores possíveis: + + - `Undefined` (0): Indefinido + + - `NaturalPerson` (2): Pessoa Física (CPF) + + - `LegalEntity` (4): Pessoa Jurídica (CNPJ) + + - `Company` (8): Prestador de serviço (uso interno — obsoleto) + + - `Customer` (16): Cliente (uso interno — obsoleto) + + ' + PrintType: + enum: + - None + - NFeNormalPortrait + - NFeNormalLandscape + - NFeSimplified + - DANFE_NFC_E + - DANFE_NFC_E_MSG_ELETRONICA + type: string + description: 'Formato de impressão do DANFE (tpImp). + + Valores possíveis: + + - `None` (0): Sem geração de DANFE + + - `NFeNormalPortrait` (1): DANFE Normal Retrato (NF-e) + + - `NFeNormalLandscape` (2): DANFE Normal Paisagem (NF-e) + + - `NFeSimplified` (3): DANFE Simplificado + + - `DANFE_NFC_E` (4): DANFE NFC-e + + - `DANFE_NFC_E_MSG_ELETRONICA` (5): DANFE NFC-e em mensagem eletrônica + + ' + ProductInvoiceEventsResource: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/ActivityResource' + description: Lista de Eventos ocorridos na Nota Fiscal + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + nullable: true + id: + type: string + description: Identificação + nullable: true + accountId: + type: string + description: Identificador da Conta + nullable: true + companyId: + type: string + description: Identificador da Empresa + nullable: true + additionalProperties: false + ProductInvoiceQueueIssueResource: + type: object + x-nota: >- + Para emissão de Nota de Crédito/Débito (`purposeType=CreditInvoice`/`DebitInvoice`), os + campos IBS/CBS de item — `competenceAdjustment` (com `assessmentPeriod`), `creditReversal` e + a referência por item `referencedDFe` — são documentados na especificação RTC (Nota Fiscal + de Produto/Consumidor RTC). Esta especificação v3 cobre o envelope de nível de nota + (`purposeType`, `creditType`, `debitType`) e o read-model de Notas de Crédito emitidas contra + a NF-e (endpoints `credit-invoices` e `credit-invoice-links`). + required: + - items + - payment + - buyer + properties: + id: + type: string + description: Identificador único + nullable: true + payment: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/PaymentResource' + description: Grupo de Formas de Pagamento (pag). Pelo menos uma forma de pagamento é obrigatória. + serie: + type: integer + description: Série do Documento Fiscal (serie) + format: int32 + nullable: true + number: + type: integer + description: Número do Documento Fiscal (nNF) + format: int64 + nullable: true + operationOn: + type: string + description: "Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt)\r\n\r\n \ + \ Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.\r\n" + format: date-time + nullable: true + operationNature: + type: string + description: Descrição da Natureza da Operação (natOp) + nullable: true + operationType: + $ref: '#/components/schemas/OperationType' + destination: + $ref: '#/components/schemas/Destination' + printType: + $ref: '#/components/schemas/PrintType' + purposeType: + $ref: '#/components/schemas/PurposeType' + creditType: + $ref: '#/components/schemas/CreditType' + debitType: + $ref: '#/components/schemas/DebitType' + consumerType: + $ref: '#/components/schemas/ConsumerType' + presenceType: + $ref: '#/components/schemas/ConsumerPresenceType' + contingencyOn: + type: string + description: "Data e Hora da entrada em contingência (dhCont)\r\n\r\n Data e hora no formato\ + \ UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD\r\n" + format: date-time + nullable: true + contingencyJustification: + type: string + description: Justificativa da entrada em contingência (xJust) + nullable: true + buyer: + $ref: '#/components/schemas/BuyerResource' + transport: + $ref: '#/components/schemas/TransportInformationResource' + additionalInformation: + $ref: '#/components/schemas/AdditionalInformationResource' + export: + $ref: '#/components/schemas/ExportResource' + items: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/InvoiceItemResource' + description: Detalhamento de Produtos e Serviços (det). Pelo menos um item é obrigatório. + billing: + $ref: '#/components/schemas/BillingResource' + issuer: + $ref: '#/components/schemas/IssuerFromRequestResource' + transactionIntermediate: + $ref: '#/components/schemas/IntermediateResource' + delivery: + $ref: '#/components/schemas/DeliveryInformationResource' + withdrawal: + $ref: '#/components/schemas/WithdrawalInformationResource' + totals: + $ref: '#/components/schemas/Total' + additionalProperties: false + description: Notas Fiscais Eletrônicas (NFe) + ProductInvoicesResource: + type: object + properties: + productInvoices: + type: array + items: + $ref: '#/components/schemas/InvoiceWithoutEventsResource' + description: Lista de Notas Fiscais Eletrônicas (NF-e) + nullable: true + hasMore: + type: boolean + description: Identificador de possibilidade de mais itens. + additionalProperties: false + description: Notas Fiscais Eletrônicas (NF-e) + PumpResource: + type: object + properties: + spoutNumber: + type: integer + description: Número de identificação do bico utilizado no abastecimento (nBico) + format: int32 + nullable: true + number: + type: integer + description: Número de identificação da bomba ao qual o bico está interligado (nBomba) + format: int32 + nullable: true + tankNumber: + type: integer + description: Número de identificação do tanque ao qual o bico está interligado (nTanque) + format: int32 + nullable: true + beginningAmount: + type: number + description: Valor do Encerrante no início do abastecimento (vEncIni) + format: double + nullable: true + endAmount: + type: number + description: Valor do Encerrante no final do abastecimento (vEncFin) + format: double + nullable: true + percentageBio: + type: number + description: Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão + regulamentador + format: double + nullable: true + additionalProperties: false + CreditType: + type: string + nullable: true + description: | + Tipo de Nota de Crédito (tpNFCredito). Obrigatório quando `purposeType=CreditInvoice`. + Valores possíveis: + - `RefusedDeliveryTotalOrNotFound` (03): Retorno por Recusa Total na Entrega ou por Não Localização do destinatário (referência da NF-e original em `additionalInformation.taxDocumentsReference`). + - `RefusedDeliveryPartial` (06): Retorno por Recusa Parcial na Entrega (Ajuste SINIEF 8/26 — exige referência por item em `items[].referencedDFe`). + enum: + - RefusedDeliveryTotalOrNotFound + - RefusedDeliveryPartial + DebitType: + type: string + nullable: true + description: | + Tipo de Nota de Débito (tpNFDebito). Obrigatório quando `purposeType=DebitInvoice`. + Valores possíveis: + - `TransferCreditsToCooperatives` (01): Transferência de créditos para cooperativas + - `CancelCreditsExemptImmuneSales` (02): Cancelamento de créditos por vendas isentas/imunes + - `UnprocessedInvoicesDebits` (03): Débitos de faturas não processadas no cálculo + - `FinesAndInterest` (04): Multas e juros + - `TransferInheritanceCredit` (05): Transferência de crédito na sucessão + - `AdvancePayment` (06): Pagamento antecipado + - `InventoryLoss` (07): Perda de estoque + - `SnDisqualification` (08): Desenquadramento do Simples Nacional + enum: + - TransferCreditsToCooperatives + - CancelCreditsExemptImmuneSales + - UnprocessedInvoicesDebits + - FinesAndInterest + - TransferInheritanceCredit + - AdvancePayment + - InventoryLoss + - SnDisqualification + CreditInvoiceReferenceResource: + type: object + additionalProperties: false + description: Vínculo entre uma NF-e e uma Nota de Crédito por recusa que a referenciou (item da lista `creditInvoicesIssuedAgainst`). + properties: + creditInvoiceId: + type: string + nullable: true + description: Identificador interno (aggregate id) da Nota de Crédito. + creditInvoiceAccessKey: + type: string + nullable: true + description: Chave SEFAZ de 44 caracteres da Nota de Crédito. + creditType: + $ref: '#/components/schemas/CreditType' + issuedAt: + type: string + format: date-time + nullable: true + description: Data/hora de emissão/autorização da Nota de Crédito. + referencedItemNumbers: + type: array + nullable: true + description: '`null` para `RefusedDeliveryTotalOrNotFound` (referência no nível da NF-e); lista de `nItem` distintos para `RefusedDeliveryPartial` (referência por item).' + items: + type: integer + format: int32 + CreditInvoicesListResource: + type: object + additionalProperties: false + description: Resposta do endpoint `GET .../credit-invoices` — lista as Notas de Crédito por recusa que referenciaram a NF-e original. + properties: + invoiceId: + type: string + nullable: true + description: Id (aggregate id) da NF-e original consultada. + invoiceAccessKey: + type: string + nullable: true + description: Chave SEFAZ de 44 caracteres da NF-e original. + creditInvoices: + type: array + description: Notas de Crédito por recusa que referenciaram esta NF-e. Sempre uma lista (vazia quando não há vínculos). + items: + $ref: '#/components/schemas/CreditInvoiceReferenceResource' + LinkCreditInvoiceRequestResource: + type: object + additionalProperties: false + description: Body do endpoint `POST .../credit-invoice-links` — dispara o vínculo explícito de uma Nota de Crédito contra a NF-e original. Idempotente. + required: + - creditInvoiceId + properties: + creditInvoiceId: + type: string + description: Id (aggregate id) da Nota de Crédito a ser vinculada à NF-e original. + PurposeType: + enum: + - None + - Normal + - Complement + - Adjustment + - Devolution + - CreditInvoice + - DebitInvoice + type: string + description: 'Finalidade da emissão da NF-e (finNFe). + + Valores possíveis: + + - `None` (0): Nenhum + + - `Normal` (1): NF-e Normal (operação comum de venda/saída) + + - `Complement` (2): NF-e Complementar (complementa valores de uma nota anterior) + + - `Adjustment` (3): NF-e de Ajuste (regulariza divergências fiscais) + + - `Devolution` (4): Devolução de mercadoria + + - `CreditInvoice` (5): Nota de Crédito (Ajuste SINIEF 49/25) — requer `creditType` + + - `DebitInvoice` (6): Nota de Débito (Ajuste SINIEF 49/25) — requer `debitType` + + ' + QueueEventResource: + type: object + properties: + reason: + type: string + description: "Justificativa da carta de correção\r\nO Texto deve conter no mínimo 15 e no máximo 1.000\ + \ caracteres\r\n(os quais não poderão conter acentos e/ou caracteres especiais)" + nullable: true + additionalProperties: false + ReboqueResource: + type: object + properties: + plate: + type: string + description: Placa do Veiculo (placa) + nullable: true + uf: + type: string + description: UF Veiculo Reboque (UF) + nullable: true + rntc: + type: string + description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) + nullable: true + wagon: + type: string + description: Identificação do Vagão (vagao) + nullable: true + ferry: + type: string + description: Identificação da Balsa (balsa) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Reboque" + ReceiverStateTaxIndicator: + enum: + - None + - TaxPayer + - Exempt + - NonTaxPayer + type: string + description: 'Indicador de Inscrição Estadual do destinatário (indIEDest). + + Valores possíveis: + + - `None` (0): Nenhum + + - `TaxPayer` (1): Contribuinte ICMS (informar a IE do destinatário) + + - `Exempt` (2): Contribuinte isento de Inscrição no cadastro de Contribuintes + + - `NonTaxPayer` (9): Não Contribuinte (pode ou não possuir IE no Cadastro de Contribuintes do ICMS) + + ' + ReferencedProcessResource: + type: object + properties: + identifierConcessory: + type: string + nullable: true + identifierOrigin: + type: integer + format: int32 + nullable: true + concessionActType: + type: integer + format: int32 + nullable: true + additionalProperties: false + RequestCancellationResource: + type: object + properties: + accountId: + type: string + nullable: true + companyId: + type: string + nullable: true + productInvoiceId: + type: string + nullable: true + reason: + type: string + nullable: true + additionalProperties: false + ShippingModality: + enum: + - ByIssuer + - ByReceiver + - ByThirdParties + - OwnBySender + - OwnByBuyer + - Free + type: string + description: 'Modalidade do frete (modFrete). + + Valores possíveis: + + - `ByIssuer` (0): Contratação do Frete por conta do Remetente (CIF) + + - `ByReceiver` (1): Contratação do Frete por conta do Destinatário (FOB) + + - `ByThirdParties` (2): Contratação do Frete por conta de Terceiros + + - `OwnBySender` (3): Transporte próprio por conta do Remetente + + - `OwnByBuyer` (4): Transporte próprio por conta do Destinatário + + - `Free` (9): Sem Ocorrência de transporte + + ' + SpecialTaxRegime: + enum: + - Nenhum + - MicroempresaMunicipal + - Estimativa + - SociedadeDeProfissionais + - Cooperativa + - MicroempreendedorIndividual + - MicroempresarioEmpresaPequenoPorte + - Automatico + type: string + description: 'Regime Especial de Tributação (indRegTrib) — aplicável principalmente a prestadores de serviços. + + Valores possíveis: + + - `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) + + - `Automatico`: Determinação automática pela API conforme o cadastro da empresa + + ' + StateCode: + enum: + - NA + - RO + - AC + - AM + - RR + - PA + - AP + - TO + - MA + - PI + - CE + - RN + - PB + - PE + - AL + - SE + - BA + - MG + - ES + - RJ + - SP + - PR + - SC + - RS + - MS + - MT + - GO + - DF + - EX + type: string + description: 'Sigla das Unidades Federativas (UF) do Brasil, incluindo casos especiais. + + Valores possíveis: + + - `NA`: Não Aplicável + + - `RO`: Rondônia + + - `AC`: Acre + + - `AM`: Amazonas + + - `RR`: Roraima + + - `PA`: Pará + + - `AP`: Amapá + + - `TO`: Tocantins + + - `MA`: Maranhão + + - `PI`: Piauí + + - `CE`: Ceará + + - `RN`: Rio Grande do Norte + + - `PB`: Paraíba + + - `PE`: Pernambuco + + - `AL`: Alagoas + + - `SE`: Sergipe + + - `BA`: Bahia + + - `MG`: Minas Gerais + + - `ES`: Espírito Santo + + - `RJ`: Rio de Janeiro + + - `SP`: São Paulo + + - `PR`: Paraná + + - `SC`: Santa Catarina + + - `RS`: Rio Grande do Sul + + - `MS`: Mato Grosso do Sul + + - `MT`: Mato Grosso + + - `GO`: Goiás + + - `DF`: Distrito Federal + + - `EX`: Exterior (operações com o exterior) + + ' + StateTaxProcessingAuthorizer: + enum: + - Normal + - EPEC + type: string + description: 'Autorizador SEFAZ responsável pelo processamento da nota fiscal. + + Valores possíveis: + + - `Normal`: Autorizador normal (SEFAZ da UF do emitente) + + - `EPEC`: Evento Prévio de Emissão em Contingência (autorizador SVC para contingência) + + ' + TaxCouponInformationResource: + type: object + properties: + modelDocumentFiscal: + type: string + description: Modelo de Documento Fiscal (mod) + nullable: true + orderECF: + type: string + description: Número de Ordem Sequencial do ECF (nECF) + nullable: true + orderCountOperation: + type: integer + description: Número do Contador de Ordem de Operação (nCOO) + format: int32 + nullable: true + additionalProperties: false + TaxDeterminationResource: + type: object + properties: + operationCode: + type: integer + description: Código interno para determinação de natureza de operação + format: int32 + nullable: true + issuerTaxProfile: + type: string + description: Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos + nullable: true + buyerTaxProfile: + type: string + description: Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos + nullable: true + origin: + type: string + description: Origem da mercadoria + nullable: true + acquisitionPurpose: + type: string + description: Finalidade de aquisição - usado para o cálculo automático de impostos + nullable: true + additionalProperties: false + TaxDocumentsReferenceResource: + type: object + properties: + taxCouponInformation: + $ref: '#/components/schemas/TaxCouponInformationResource' + documentInvoiceReference: + $ref: '#/components/schemas/DocumentInvoiceReferenceResource' + documentElectronicInvoice: + $ref: '#/components/schemas/DocumentElectronicInvoiceResource' + additionalProperties: false + TaxRegime: + enum: + - None + - LucroReal + - LucroPresumido + - SimplesNacional + - SimplesNacionalExcessoSublimite + - MicroempreendedorIndividual + - Isento + type: string + description: 'Código de Regime Tributário (CRT) da empresa. + + Valores possíveis: + + - `None`: Nenhum / Não informado + + - `LucroReal`: Lucro Real (Regime Normal) + + - `LucroPresumido`: Lucro Presumido (Regime Normal) + + - `SimplesNacional`: Simples Nacional + + - `SimplesNacionalExcessoSublimite`: Simples Nacional — excesso de sublimite de receita bruta + + - `MicroempreendedorIndividual`: Microempreendedor Individual (MEI) + + - `Isento`: Isento de tributação + + ' + TaxpayerCommentsResource: + type: object + properties: + field: + type: string + description: Campo (xCampo) + nullable: true + text: + type: string + description: Texto (xTexto) + nullable: true + additionalProperties: false + Total: + type: object + properties: + icms: + $ref: '#/components/schemas/ICMSTotal' + issqn: + $ref: '#/components/schemas/ISSQNTotal' + additionalProperties: false + TotalResource: + type: object + properties: + icms: + $ref: '#/components/schemas/ICMSTotalResource' + issqn: + $ref: '#/components/schemas/ISSQNTotalResource' + additionalProperties: false + TransportGroupResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual do Transportador (IE) + nullable: true + transportRetention: + type: string + description: Grupo de Retenção do ICMS do transporte + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Transportador" + TransportInformationResource: + type: object + properties: + freightModality: + $ref: '#/components/schemas/ShippingModality' + transportGroup: + $ref: '#/components/schemas/TransportGroupResource' + reboque: + $ref: '#/components/schemas/ReboqueResource' + volume: + $ref: '#/components/schemas/VolumeResource' + transportVehicle: + $ref: '#/components/schemas/TransportVehicleResource' + sealNumber: + type: string + description: Número dos Lacres + nullable: true + transpRate: + $ref: '#/components/schemas/TransportRateResource' + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo de Informações do Transporte da NF-e\r\nId:\ + \ X01 Pai: A1" + TransportRateResource: + type: object + properties: + serviceAmount: + type: number + description: Valor do Serviço (vServ) + format: double + nullable: true + bcRetentionAmount: + type: number + description: BC da Retenção do ICMS (vBCRet) + format: double + nullable: true + icmsRetentionRate: + type: number + description: Alíquota da Retenção (pICMSRet) //Change to Rate + format: double + nullable: true + icmsRetentionAmount: + type: number + description: Valor do ICMS Retido (vICMSRet) + format: double + nullable: true + cfop: + type: integer + description: CFOP de Serviço de Transporte (CFOP) + format: int64 + nullable: true + cityGeneratorFactCode: + type: integer + description: Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) + format: int64 + nullable: true + additionalProperties: false + TransportVehicleResource: + type: object + properties: + plate: + type: string + description: Placa do Veiculo (placa) + nullable: true + state: + type: string + description: Sigla da UF (UF) + nullable: true + rntc: + type: string + description: Registro Nacional de Transportador de Carga (ANTT) (RNTC) + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nGrupo Veiculo" + VolumeResource: + type: object + properties: + volumeQuantity: + type: integer + description: Quantidade de volumes transportados (qVol) + format: int32 + nullable: true + species: + type: string + description: Espécie dos volumes transportados (esp) + nullable: true + brand: + type: string + description: Marca dos Volumes Transportados (marca) + nullable: true + volumeNumeration: + type: string + description: Numeração dos Volumes Transportados (nVol) + nullable: true + netWeight: + type: number + description: Peso Liquido(em Kg) (pesoL) + format: double + nullable: true + grossWeight: + type: number + description: Peso Bruto(em Kg) (pesoB) + format: double + nullable: true + additionalProperties: false + description: "Manual_de_Orientação_Contribuinte_v_5.00\r\nVolumes\r\nId:X26" + WithdrawalInformationResource: + type: object + properties: + accountId: + type: string + description: Identificador da Conta + nullable: true + id: + type: string + description: Identificação + nullable: true + name: + type: string + description: Nome ou Razão Social (xNome) + nullable: true + federalTaxNumber: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; na + entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + nullable: true + email: + type: string + description: Email + nullable: true + address: + $ref: '#/components/schemas/AddressResource' + type: + $ref: '#/components/schemas/PersonType' + stateTaxNumber: + type: string + description: Inscrição Estadual (IE) + nullable: true + additionalProperties: false + description: Identificação do Local de retirada (retirada) + securitySchemes: + Authorization_Header: + type: apiKey + description: Autenticar usando o cabeçalho HTTP + name: Authorization + in: header + Authorization_QueryParam: + type: apiKey + description: Autenticar usando o parâmetro na URL + name: apikey + in: query + Authorization_JwtBearer: + type: http + description: Autenticar usando o cabeçalho HTTP + scheme: bearer + bearerFormat: Json Web Token +security: +- Authorization_Header: [] + Authorization_QueryParam: [] +- Authorization_JwtBearer: [] +x-original-swagger-version: '2.0' diff --git a/openapi/nf-servico-v1.yaml b/openapi/nf-servico-v1.yaml index e97cf38..c3b0bc9 100644 --- a/openapi/nf-servico-v1.yaml +++ b/openapi/nf-servico-v1.yaml @@ -6345,7 +6345,7 @@ paths: description: Data da última modificação type: string "400": - description: Algum parametro informado não é válido + description: Algum parâmetro informado não é válido — verifique a resposta. Também ocorre quando o prestador (a empresa do company_id) possui CNPJ alfanumérico, não suportado nas rotas v1/v2 — a resposta é o texto "Prestador com CNPJ alfanumérico requer a API v3; as rotas v1/v2 não suportam CNPJ alfanumérico". Migre a chamada para a V3. content: application/json: schema: @@ -7675,7 +7675,7 @@ paths: description: Data da última modificação type: string "400": - description: Algum parametro informado não é válido + description: Algum parâmetro informado não é válido — verifique a resposta. Também ocorre quando a nota contém CNPJ alfanumérico (prestador, tomador, destinatário ou intermediário) — as rotas v1/v2 não a entregam e a resposta é o texto "Esta nota fiscal contém CNPJ alfanumérico e requer a API v3; as rotas v1/v2 não suportam CNPJ alfanumérico". content: application/json: schema: diff --git a/openapi/nf-servico-v3.yaml b/openapi/nf-servico-v3.yaml new file mode 100644 index 0000000..e07d297 --- /dev/null +++ b/openapi/nf-servico-v3.yaml @@ -0,0 +1,6803 @@ +openapi: 3.0.0 +servers: +- url: https://api.nfe.io + description: Nota Fiscal de Serviço +info: + title: Nota Fiscal de Serviço (V3) + version: v3 + description: "**V3 — suporte a CNPJ alfanumérico (IN RFB 2.229/2024).** Esta versão aceita prestadores e tomadores\ + \ com CNPJ alfanumérico e retorna `federalTaxNumber` sempre como **string**. A V1 permanece congelada (somente\ + \ CNPJ numérico). A aceitação da NFS-e alfanumérica depende do webservice de cada prefeitura (gate natural).\ + \ Veja o [guia de migração](/docs/documentacao/nossa-plataforma/migracao-emissao-v2-para-v3/).\n\n# Introdução\n\ + Seja 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: + /v3/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: [] + /v3/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: [] + /v3/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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; + na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico + (IN RFB 2.229/2024). + 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\n\ + Exemplo: 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre string; + na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN RFB 2.229/2024). + 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta + é sempre string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF + numérico (IN RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta + é sempre string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF + numérico (IN RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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 + - false + - 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta + é sempre string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF + numérico (IN RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta + é sempre string; na entrada, número também é aceito por compatibilidade com + CNPJ/CPF numérico (IN RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: [] + /v3/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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: + type: string + description: CNPJ ou CPF (numérico ou alfanumérico), como texto. Na V3 a resposta é sempre + string; na entrada, número também é aceito por compatibilidade com CNPJ/CPF numérico (IN + RFB 2.229/2024). + 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: [] + /v3/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: [] + /v3/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: [] + /v3/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: [] + /v3/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: [] +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}"' diff --git a/openapi/nfse-inbound-v2.yaml b/openapi/nfse-inbound-v2.yaml new file mode 100644 index 0000000..6196441 --- /dev/null +++ b/openapi/nfse-inbound-v2.yaml @@ -0,0 +1,2056 @@ +openapi: 3.0.3 +info: + title: DFeDistribution - Inbound API + description: "API de Consulta de NF-e, CT-e e NFS-e (Distribuição) da plataforma nfe.io.\nPermite habilitar/desabilitar a busca automatica de documentos fiscais,\nconsultar metadados, XMLs, PDFs, eventos e listar documentos via OData.\n\n**Subsistemas cobertos:**\n\n- **NF-e Recebidas** (Product Invoices) — captura via SEFAZ Distribuição DFe.\n- **CT-e Recebidas** (Transportation Invoices) — captura via SEFAZ Distribuição DFe.\n- **NFS-e Recebidas** — captura via ADN (Ambiente de Dados Nacional).\n\n**Complementos:**\n\n- Documentação técnica detalhada para devs cliente:\n 02-doc-tecnica-clientes-nfe-cte-dev-pt.md (NFe + CTe),\n 02-doc-tecnica-clientes-dev-nfse-inbound-api.md (NFSe API),\n 02-doc-tecnica-clientes-dev-nfse-inbound-webhook.md (NFSe webhook).\n- Postman collection completa (55 endpoints, inclui o NFe Inbound\n exporter-friendly e a folder Bulk Export que dispara jobs no\n shared-usage-api), em duas linguagens:\n PT ·\n EN.\n\n**Novidades v2.3 (2026-05-07):**\n\n- **Schemas de resposta enriquecidos** — todos os schemas em\n `components.schemas` ganharam um `example` próprio renderizavel\n pelo Swagger UI; respostas 4xx/5xx (BadRequest, Unauthorized,\n Forbidden, NotFound, Conflict, UnprocessableEntity, InternalError)\n passaram a expor exemplo de payload de erro.\n- Novos schemas: `AsyncAcceptedResource` (corpo padrao de respostas\n 202 com `documentId`/`companyId` para correlacao), `NFeMetadataListResource`,\n `ListInboundNfeResponse`, `CTeBatchConsolidationRequest`,\n `AutomaticManifestingResource`, `NFeEventMetadataResource`.\n- `EnableInboundProductInvoiceResource` agora documenta os campos\n `webhookEvents`, `webhookVersion` e o sub-objeto\n `automaticManifesting.minutesToOperationConfirmation`/`minutesToUnknownOperation`.\n- `ProductInvoiceInboundResource` e `TransportationInvoiceInboundResource`\n passaram a refletir os campos reais de retorno (`companyId`, `status`,\n `createdOn`, `modifiedOn`).\n\n**Novidades v2.2 (2026-05-06):**\n\n- Adicionados 4 endpoints sob `/v2/companies/{companyId}/inbound/nfe/...`\n (NFe Inbound exporter-friendly), incluindo o novo `GET /{accessKey}`\n consumido pelo exporter analitico CSV.\n- Documentado suporte a **bulk export CSV** via shared-usage-api:\n novos resources `company-nfse-inbound-analytical-csv` e\n `company-nfe-inbound-analytical-csv` que produzem uma planilha\n achatando cada nota + evento relacionado primario na mesma linha.\n Veja 04-guia-uso-console.md e\n 05-guia-onboarding.md para uso pelo\n console e 02-doc-tecnica-clientes-nfe-cte-dev-pt.md\n para integracao via API.\n" + version: '2.3' + contact: + name: nfe.io + url: https://nfe.io +servers: +- url: https://api.nfse.io + description: Producao +- url: https://api.nfse.io + description: Homologacao +security: +- ApiKey: [] +tags: +- name: NFSe Inbound + description: 'Endpoints para captura e manifestacao de NFS-e (Nota Fiscal de Servicos + + eletronica) via DFeTech.Api.Inbound. Cobre documentos, eventos de + + manifestacao do tomador (ciencia / rejeicao), empresas, manutencao e + + reprocessamento. Todas as rotas compartilham o prefixo + + `v2/companies/{companyId}/inbound/nfse/...`. + + ' +paths: + /v2/companies/inbound/nfse: + get: + tags: + - NFSe Inbound + summary: Listar empresas configuradas para captura inbound NFS-e + operationId: listNFSeCompanies + parameters: + - name: pageIndex + in: query + schema: + type: integer + minimum: 1 + default: 1 + - name: pageCount + in: query + schema: + type: integer + minimum: 0 + default: 0 + description: 0 usa DefaultPageSize; limite MaxPageSize aplicado. + - name: isActive + in: query + schema: + type: boolean + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCompanyCollectionResource' + '400': + $ref: '#/components/responses/BadRequest' + post: + tags: + - NFSe Inbound + summary: Cadastrar empresa inbound NFS-e (companyId vem no body) + operationId: createNFSeCompany + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCreateInboundCompanyRequest' + responses: + '201': + description: Criado + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCompanyResource' + '400': + $ref: '#/components/responses/BadRequest' + '409': + $ref: '#/components/responses/Conflict' + /v2/companies/{companyId}/inbound/nfse: + get: + tags: + - NFSe Inbound + summary: Listar documentos fiscais NFS-e capturados + operationId: listNFSeDocuments + parameters: + - $ref: '#/components/parameters/companyId' + - name: environment + in: query + schema: + type: string + enum: + - Production + - Development + - name: pageIndex + in: query + schema: + type: integer + minimum: 1 + default: 1 + - name: pageCount + in: query + schema: + type: integer + minimum: 0 + default: 0 + - name: type + in: query + schema: + type: string + enum: + - None + - Dps + - EventRegistrationRequest + - Nfse + - Event + - Cnc + description: 'Filtro por tipo de documento (input). Aceita o nome do enum `NFSeDocumentType` — + + **nota**: o response renomeia o valor `Nfse` para `serviceInvoice` (ver schema + + `NFSeDocumentDetailResource.type`), mas o query param continua aceitando `Nfse` + + como entrada (model binding default). + + ' + - name: eventType + in: query + schema: + type: string + description: Subtipo de evento (quando type=Event). + - name: status + in: query + schema: + type: string + enum: + - Pending + - Processed + - Failed + - PdfPending + - PdfFailed + - name: webhookStatus + in: query + schema: + type: string + enum: + - Pending + - Delivered + - Failed + - DefinitivelyFailed + - name: nsuBegin + in: query + schema: + type: integer + format: int64 + - name: nsuEnd + in: query + schema: + type: integer + format: int64 + - name: createdBegin + in: query + schema: + type: string + format: date-time + - name: createdEnd + in: query + schema: + type: string + format: date-time + - name: issuedBegin + in: query + schema: + type: string + format: date-time + - name: issuedEnd + in: query + schema: + type: string + format: date-time + - name: federalTaxNumber + in: query + schema: + type: string + description: Filtra por CNPJ/CPF (provider ou borrower). + - name: hasTotals + in: query + schema: + type: boolean + default: false + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeDocumentCollectionResource' + '400': + $ref: '#/components/responses/BadRequest' + /v2/companies/{companyId}/inbound/nfse/details: + get: + tags: + - NFSe Inbound + summary: Obter detalhes de uma empresa inbound NFS-e + operationId: getNFSeCompanyDetails + parameters: + - $ref: '#/components/parameters/companyId' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCompanyResource' + '404': + $ref: '#/components/responses/NotFound' + put: + tags: + - NFSe Inbound + summary: Atualizar configuracao de empresa inbound NFS-e + operationId: updateNFSeCompany + parameters: + - $ref: '#/components/parameters/companyId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeUpdateInboundCompanyRequest' + responses: + '200': + description: Atualizado + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCompanyResource' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + delete: + tags: + - NFSe Inbound + summary: Desativar empresa inbound NFS-e (soft delete) + description: 'Soft delete — `isActive` passa a `false` e a empresa para de ser polled. + + Pode ser reativada via `/maintenance/reactivate`. Resposta de sucesso + + é **`200 OK` com corpo vazio** (`ReturnResult(Result)` no + + `ApiBaseController`). + + ' + operationId: deactivateNFSeCompany + parameters: + - $ref: '#/components/parameters/companyId' + responses: + '200': + description: Desativada (sem corpo). + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/reset-nsu: + post: + tags: + - NFSe Inbound + summary: Redefinir o NSU atual de uma empresa para reprocessar documentos + description: 'Atribui um novo `currentNsu` à empresa, fazendo com que a próxima + + captura inicie a partir dele. Use com cautela — documentos entre o + + novo NSU e o anterior serão re-emitidos no webhook. Resposta de + + sucesso é **`200 OK` com corpo vazio**. + + ' + operationId: resetNFSeNsu + parameters: + - $ref: '#/components/parameters/companyId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeResetNsuRequest' + responses: + '200': + description: NSU redefinido (sem corpo). + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/{id}: + get: + tags: + - NFSe Inbound + summary: Obter detalhes de um documento NFS-e (por ID ou por chave de acesso) + description: 'O parâmetro `{id}` aceita tanto o ID interno do documento quanto a chave + + de acesso NFS-e (50 dígitos). Detecção automática via regex `^\d{50}$`. + + Quando é chave de acesso, retorna o documento primário (NFS-e preferida + + sobre eventos). + + ' + operationId: getNFSeDocument + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeDocumentDetailResource' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/{id}/xml: + get: + tags: + - NFSe Inbound + summary: Redirecionar para download do XML (aceita ID ou chave de acesso) + operationId: downloadNFSeXml + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '302': + description: Redirect para URL assinada + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/{id}/pdf: + get: + tags: + - NFSe Inbound + summary: Redirecionar para download do PDF (aceita ID ou chave de acesso) ou 202 se pendente + description: 'Retorna `302` quando o PDF esta disponivel (redirect para URL assinada + + S3 de curta expiracao) ou `202` com `{ "message": "PDF is being + + generated..." }` quando o PDF ainda esta sendo gerado (async). + + ' + operationId: downloadNFSePdf + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '302': + description: PDF pronto, redirect para URL assinada + '202': + description: PDF ainda sendo gerado + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResource' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/{id}/json: + get: + tags: + - NFSe Inbound + summary: Devolve o XML capturado convertido em JSON (aceita ID ou chave de acesso) + description: 'Retorna o XML capturado do documento fiscal convertido em JSON literal, + + inline (`200 application/json`). Diferente de `/xml` e `/pdf`, NÃO há + + redirect — o payload é devolvido no body da resposta. A conversão + + espelha 1:1 a estrutura do XML: atributos viram propriedades prefixadas + + com `@` (ex.: `@versao`), texto inline em elementos com atributos vira + + `#text`, namespaces como `@xmlns` / `@xmlns:prefix`. Aceita qualquer + + tipo de documento com XML armazenado (Nfse, Event, Dps, Cnc, + + EventRegistrationRequest). + + ' + operationId: downloadNFSeJson + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '200': + description: JSON resultante da conversão literal do XML + content: + application/json: + schema: + type: object + description: 'Espelha 1:1 a árvore XML do documento. Estrutura depende do + + tipo de documento — sem schema fixo (campos dinâmicos). + + ' + '404': + $ref: '#/components/responses/NotFound' + '503': + description: 'Throttling temporário do S3 após retries internos do SDK. O cliente + + deve aguardar e refazer a requisição (o retorno inclui o header + + `Retry-After` em segundos). + + ' + headers: + Retry-After: + schema: + type: integer + example: 30 + description: Segundos sugeridos antes de tentar novamente. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 503 + message: S3 temporarily throttled. Please retry shortly. + /v2/companies/{companyId}/inbound/nfse/{id}/reprocess: + post: + tags: + - NFSe Inbound + summary: Reenfileirar um documento para reprocessamento (aceita ID ou chave de acesso) + description: 'Reenfileira o documento para reprocessamento (parsing + persistência + + + webhook). O processamento é assíncrono — acompanhe via `GET /{id}` ou + + webhook. Conta no contador `reprocessCount` do detalhamento. + + ' + operationId: reprocessNFSeDocument + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '202': + description: Reenfileirado + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncAcceptedResource' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/{id}/resend-webhook: + post: + tags: + - NFSe Inbound + summary: Reenfileirar entrega do webhook de um documento (aceita ID ou chave de acesso) + description: 'Reenfileira somente a entrega do webhook (não reprocessa o documento). + + Útil quando o consumidor estava indisponível e quer disparar retry + + manual. Retorna 202; acompanhe via `webhookStatus` no detalhamento. + + ' + operationId: resendNFSeWebhook + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseDocumentIdOrAccessKey' + responses: + '202': + description: Reenfileirado + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncAcceptedResource' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/by-access-key/{accessKey}/manifestations: + get: + tags: + - NFSe Inbound + summary: Listar eventos de manifestacao submetidos para uma NFS-e + operationId: listNFSeManifestationsByAccessKey + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseAccessKey' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeManifestationEventCollectionResource' + '404': + $ref: '#/components/responses/NotFound' + post: + tags: + - NFSe Inbound + summary: Submeter evento de manifestacao do tomador (ciencia / rejeicao) + description: 'Aceita somente eventos do tomador: `203202` (Confirmacao) e + + `203206` (Rejeicao). Para `203206`, `reasonCode` e obrigatorio + + (valores validos: 1, 2, 3, 4, 5, 9). Processamento e assincrono + + via fila `inbound-submit-manifestation`. O corpo da resposta e o + + resource inicial com `status: "Pending"`; o cliente deve acompanhar + + a transicao via `GET /manifestations/{id}` ou webhook. + + ' + operationId: submitNFSeManifestation + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/nfseAccessKey' + - name: eventCode + in: query + required: true + schema: + type: integer + enum: + - 203202 + - 203206 + description: 203202 = Confirmacao; 203206 = Rejeicao (requer reasonCode). + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeSubmitManifestationEventRequest' + responses: + '202': + description: Aceito para processamento assincrono + headers: + Location: + schema: + type: string + description: URL do endpoint GET /manifestations/{id} para acompanhar. + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeManifestationEventResource' + '400': + $ref: '#/components/responses/BadRequest' + '404': + $ref: '#/components/responses/NotFound' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + /v2/companies/{companyId}/inbound/nfse/manifestations/{id}: + get: + tags: + - NFSe Inbound + summary: Obter detalhes de um evento de manifestacao (inclui request/response XML) + operationId: getNFSeManifestation + parameters: + - $ref: '#/components/parameters/companyId' + - name: id + in: path + required: true + schema: + type: string + description: ID do evento de manifestacao (ObjectId). + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeManifestationEventDetailResource' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/maintenance/fetch-now: + post: + tags: + - NFSe Inbound + summary: Disparar captura imediata de documentos (fetch sob demanda) — requer role Management + description: 'Dispara um ciclo imediato de captura ADN para a empresa, fora da + + janela de polling normal. Útil para validar configuração após cadastro + + ou após reset de NSU. O processamento é assíncrono. + + ' + operationId: fetchNFSeNow + parameters: + - $ref: '#/components/parameters/companyId' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeFetchNowRequest' + responses: + '202': + description: Fetch enfileirado + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncAcceptedResource' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/maintenance/notifications: + get: + tags: + - NFSe Inbound + summary: Listar notificacoes de manutencao (requer role Management) + operationId: listNFSeNotifications + parameters: + - $ref: '#/components/parameters/companyId' + - name: severity + in: query + schema: + type: string + enum: + - Info + - Warning + - Critical + - name: type + in: query + schema: + type: string + - name: pageIndex + in: query + schema: + type: integer + minimum: 1 + default: 1 + - name: pageCount + in: query + schema: + type: integer + minimum: 0 + default: 0 + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeNotificationCollectionResource' + '400': + $ref: '#/components/responses/BadRequest' + '403': + $ref: '#/components/responses/Forbidden' + /v2/companies/{companyId}/inbound/nfse/maintenance/statistics: + get: + tags: + - NFSe Inbound + summary: Visao operacional de uma empresa (campos internos + estatisticas) + operationId: getNFSeStatistics + parameters: + - $ref: '#/components/parameters/companyId' + responses: + '200': + description: Sucesso + content: + application/json: + schema: + $ref: '#/components/schemas/NFSeCompanyOpsViewResource' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/{companyId}/inbound/nfse/maintenance/reactivate: + post: + tags: + - NFSe Inbound + summary: Reativar uma empresa inbound previamente desativada + description: 'Força reativação manual — útil após resolução do motivo registrado em + + `deactivationReason`. Resposta de sucesso é **`200 OK` com corpo vazio**. + + ' + operationId: reactivateNFSeCompany + parameters: + - $ref: '#/components/parameters/companyId' + responses: + '200': + description: Reativada (sem corpo). + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + /v2/companies/inbound/nfse/blob/download: + get: + tags: + - NFSe Inbound + summary: Download de blob XML/PDF via URL assinada HMAC (sem autenticacao) + description: 'Endpoint publico protegido unicamente pela assinatura HMAC. Os + + parametros `b` (blob path), `e` (expiration ticks) e `s` + + (signature) sao gerados por `NFSeUrlSigner` e embutidos nas URLs + + retornadas nos 302 dos endpoints `/xml` e `/pdf`. Nao e chamado + + diretamente pelo cliente — o redirect 302 leva o browser/HttpClient + + ate aqui automaticamente. + + ' + operationId: downloadNFSeBlob + security: [] + parameters: + - name: b + in: query + required: true + schema: + type: string + description: Caminho do blob no storage. + - name: e + in: query + required: true + schema: + type: integer + format: int64 + description: Expiration em DateTime.Ticks (UTC). + - name: s + in: query + required: true + schema: + type: string + description: Assinatura HMAC-SHA256 URL-safe base64. + responses: + '200': + description: Stream binario do XML ou do PDF. + content: + application/pdf: + schema: + type: string + format: binary + application/xml: + schema: + type: string + format: binary + '400': + description: 'Parametros `b`/`e`/`s` ausentes ou malformados, **ou** link expirado + + (timestamp `e` no passado). O corpo é texto puro com a mensagem + + literal retornada pelo controller. + + ' + content: + text/plain: + schema: + type: string + examples: + missingParams: + summary: Parâmetros ausentes/malformados + value: Invalid parameters. + expiredLink: + summary: Link expirado + value: Link expired. + '401': + description: Assinatura HMAC inválida. + content: + text/plain: + schema: + type: string + example: Invalid signature. + '404': + description: Arquivo nao encontrado no storage. + content: + text/plain: + schema: + type: string + example: File not found. + '503': + description: 'Throttling temporário do S3. Aguarde e refaça a requisição (o + + retorno inclui o header `Retry-After` em segundos). + + ' + headers: + Retry-After: + schema: + type: integer + example: 30 + description: Segundos sugeridos antes de tentar novamente. + content: + text/plain: + schema: + type: string + example: S3 temporarily throttled. Please retry shortly. +components: + securitySchemes: + ApiKey: + type: apiKey + in: header + name: Authorization + description: 'API Key da conta nfe.io enviada no header `Authorization` (sem prefixo + + `Bearer`). A mesma chave usada nas demais APIs da plataforma. As roles + + relevantes são `NFeDist`, `CTeDist` e `NFSeDist` — somente endpoints + + cujas policies o token cobre são acessíveis. + + ' + parameters: + company_id: + name: company_id + in: path + required: true + schema: + type: string + example: 5f4d4cee0a8b8e2c3a1bcd11 + description: ID da empresa na plataforma nfe.io (snake_case, usado pelas rotas NF-e/CT-e legadas). + access_key: + name: access_key + in: path + required: true + schema: + type: string + minLength: 44 + maxLength: 44 + example: '35240612345678000195550010000012341123456789' + description: Chave de acesso do documento NF-e/CT-e (44 dígitos numéricos). + event_key: + name: event_key + in: path + required: true + schema: + type: string + example: '35240612345678000195550010000012341123456789110111' + description: Chave do evento (50 dígitos = 44 da NF-e/CT-e + tpEvento + sequência). + companyId: + name: companyId + in: path + required: true + schema: + type: string + example: 5f4d4cee0a8b8e2c3a1bcd11 + description: ID da empresa (camelCase, usado pelas rotas NFS-e e exporter NFe). + nfseAccessKey: + name: accessKey + in: path + required: true + schema: + type: string + pattern: ^[0-9]{50}$ + example: '12345678901234567890123456789012345678901234567890' + description: Chave de acesso NFS-e (50 dígitos numéricos). + nfseDocumentId: + name: id + in: path + required: true + schema: + type: string + example: 65fa2c11abc1234567890def + description: ID do documento NFS-e (ObjectId Mongo, 24 hex). + nfseDocumentIdOrAccessKey: + name: id + in: path + required: true + schema: + type: string + example: 65fa2c11abc1234567890def + description: 'ID do documento NFS-e (ObjectId Mongo) OU chave de acesso (50 dígitos). + + Detecção automática pelo servidor via regex `^\d{50}$`. Quando é chave + + de acesso, retorna o documento primário (NFS-e preferida sobre eventos). + + ' + responses: + BadRequest: + description: 'Parâmetro inválido ou regra de negócio violada. Os controllers que + + herdam de `ApiBaseController` retornam **`ErrorsResource`** (`{ errors: + + [...] }`) via `ReturnResult`. O endpoint público `/blob/download` é + + exceção — retorna `text/plain` (ver a operação correspondente). + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 400 + message: 'EnvironmentSEFAZ inválido. Valores permitidos: 1=Produção, 2=Homologação.' + Unauthorized: + description: 'API Key ausente, malformada ou desconhecida. O header `Authorization` + + não foi enviado, está vazio, ou não bate com nenhuma chave ativa. + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 401 + message: Invalid or missing API key. + Forbidden: + description: 'API Key válida porém sem a *policy* exigida pelo endpoint + + (`NFeDist`, `CTeDist`, `NFSeDist` ou role `Management`). Reveja as + + permissões da chave no painel. + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 403 + message: Acesso restrito a role Management. + NotFound: + description: 'Recurso não encontrado para a empresa atual. Pode ser empresa, chave + + de acesso, NSU, ID de documento ou ID de evento. + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 404 + message: Documento não encontrado. + Conflict: + description: 'Conflito de estado — recurso já existe ou há outra operação em + + andamento para a mesma chave. + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 409 + message: Empresa já cadastrada para captura inbound NFS-e. + UnprocessableEntity: + description: 'Payload sintaticamente válido porém semanticamente inválido (ex. + + `eventCode=203206` sem `reasonCode`, NSU menor que o atual, etc). + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 422 + message: ReasonCode é obrigatório quando eventCode=203206 (Rejeição). + InternalError: + description: 'Erro interno não tratado. A request foi recebida porém uma exceção + + inesperada ocorreu no servidor. Tente novamente após alguns segundos + + ou contate o suporte com o `correlation-id` (header `X-Correlation-ID`). + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorsResource' + example: + errors: + - code: 500 + message: Erro interno ao processar a requisição. + schemas: + ErrorsResource: + type: object + description: 'Wrapper retornado pelos controllers que herdam de `ApiBaseController` + + em respostas 4xx/5xx (via `ReturnResult`). É o shape canônico para + + todos os endpoints documentados nesta spec — exceto o endpoint + + público `/blob/download`, que devolve `text/plain` por design. + + ' + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResource' + example: + errors: + - code: 404 + message: Documento não encontrado. + ErrorResource: + type: object + description: Item individual dentro de `ErrorsResource.errors[]`. + properties: + code: + type: integer + description: Código numérico do erro (em geral o status HTTP, mas pode ser um código de domínio). + message: + type: string + description: Mensagem em português, pronta para exibição ao usuário final. + example: + code: 404 + message: Documento não encontrado. + InboundCompanyResource: + type: object + description: Identificação mínima da empresa dentro do escopo do documento. + properties: + id: + type: string + description: ID interno da empresa na plataforma nfe.io. + federalTaxNumber: + type: string + description: CNPJ da empresa (apenas dígitos). + example: + id: 5f4d4cee0a8b8e2c3a1bcd11 + federalTaxNumber: '12345678000195' + IssuerResource: + type: object + description: Emissor da nota (campo `emit` no XML SEFAZ). + properties: + federalTaxNumber: + type: string + description: CNPJ do emissor. + name: + type: string + description: Razão social do emissor. + example: + federalTaxNumber: '98765432000180' + name: Fornecedor Exemplo Ltda + BuyerResource: + type: object + description: Destinatário/comprador da nota (campo `dest` no XML SEFAZ). + properties: + federalTaxNumber: + type: string + description: CNPJ ou CPF do destinatário (apenas dígitos). + name: + type: string + description: Razão social ou nome do destinatário. + example: + federalTaxNumber: '12345678000195' + name: Empresa Compradora SA + TransportationResource: + type: object + description: Transportador (presente em CT-e e NF-e com transporte vinculado). + properties: + federalTaxNumber: + type: string + description: CNPJ do transportador. + name: + type: string + description: Razão social do transportador. + example: + federalTaxNumber: '11222333000144' + name: Transportadora Exemplo Ltda + MessageResource: + type: object + description: Resposta genérica de operação assíncrona ou de mensagens informativas. + properties: + message: + type: string + description: Mensagem em português pronta para exibição. + code: + type: string + description: Código interno (opcional) para correlação. + example: + message: Documento reenfileirado para reprocessamento. + code: REPROCESS_QUEUED + NFeMetadataResource: + type: object + description: 'Detalhamento completo de uma NF-e ou evento NF-e (retornado por + + `/productinvoices/{accessKey}`, `/inbound/{accessKey}` e exporter + + NFe `/inbound/nfe/{accessKey}`). + + ' + properties: + accessKey: + type: string + description: Chave de acesso (44 dígitos). + createdOn: + type: string + format: date-time + nullable: true + parentAccessKey: + type: string + nullable: true + description: Para eventos + chave da NF-e referenciada.: null + company: + $ref: '#/components/schemas/InboundCompanyResource' + issuer: + $ref: '#/components/schemas/IssuerResource' + buyer: + $ref: '#/components/schemas/BuyerResource' + transportation: + $ref: '#/components/schemas/TransportationResource' + links: + type: object + nullable: true + properties: + xml: + type: string + format: uri + nullable: true + pdf: + type: string + format: uri + nullable: true + xmlUrl: + type: string + format: uri + nullable: true + federalTaxNumberSender: + type: string + nullable: true + nameSender: + type: string + nullable: true + type: + type: string + enum: + - productInvoice + - productInvoiceEvent + - transportationInvoice + - transportationInvoiceEvent + - productInvoiceSummary + - productInvoiceEventSummary + nsu: + type: string + nullable: true + nsuParent: + type: string + nullable: true + nfeNumber: + type: string + nullable: true + nfeSerialNumber: + type: string + nullable: true + issuedOn: + type: string + format: date-time + nullable: true + description: + type: string + nullable: true + totalInvoiceAmount: + type: string + nullable: true + operationType: + type: string + enum: + - Outgoing + - Incoming + - None + environmentType: + type: integer + enum: + - 1 + - 2 + description: 1 = Produção + 2 = Homologação.: null + example: + accessKey: '35240612345678000195550010000012341123456789' + createdOn: '2026-05-06T13:20:00Z' + parentAccessKey: null + company: + id: 5f4d4cee0a8b8e2c3a1bcd11 + federalTaxNumber: '12345678000195' + issuer: + federalTaxNumber: '98765432000180' + name: Fornecedor Exemplo Ltda + buyer: + federalTaxNumber: '12345678000195' + name: Empresa Compradora SA + transportation: + federalTaxNumber: '11222333000144' + name: Transportadora Exemplo Ltda + links: + xml: https://api.nfse.io/v2/companies/.../inbound/nfe/35240612345678000195550010000012341123456789/xml + pdf: https://api.nfse.io/v2/companies/.../inbound/nfe/35240612345678000195550010000012341123456789/pdf + xmlUrl: https://nfe-prod.blob.core.windows.net/inbound/35240612345678000195550010000012341123456789.xml?sig=... + federalTaxNumberSender: '98765432000180' + nameSender: Fornecedor Exemplo Ltda + type: productInvoice + nsu: '12345' + nsuParent: null + nfeNumber: '1234' + nfeSerialNumber: '1' + issuedOn: '2026-05-06T12:30:00Z' + description: Venda de mercadoria adquirida ou recebida de terceiros + totalInvoiceAmount: '1234.56' + operationType: Incoming + environmentType: 1 + NFSeParticipantResource: + type: object + description: Participante de NFS-e (provider, borrower ou intermediary). + properties: + federalTaxNumber: + type: string + description: CNPJ ou CPF (apenas dígitos). + name: + type: string + description: Razão social ou nome do participante. + cityCode: + type: string + description: Código IBGE do município (7 dígitos). + state: + type: string + description: UF do participante (2 letras). + example: + federalTaxNumber: '12345678000195' + name: Empresa Prestadora SA + cityCode: '3550308' + state: SP + NFSeCompanyResource: + type: object + description: Empresa configurada para captura inbound de NFS-e (ADN). + properties: + id: + type: string + description: ID da empresa (mesmo do TaxPayers). + name: + type: string + environment: + type: string + enum: + - Production + - Development + description: Ambiente ADN considerado. + isActive: + type: boolean + description: false após desativação manual ou desligamento por falhas consecutivas. + initialNsu: + type: integer + format: int64 + description: NSU inicial configurado. + currentNsu: + type: integer + format: int64 + description: Próximo NSU a ser consumido pela próxima execução. + maxAvailableNsu: + type: integer + format: int64 + description: Maior NSU atualmente exposto pelo ADN. + lastExecutedAt: + type: string + format: date-time + nullable: true + description: Última execução de poll. + rateLimitedUntil: + type: string + format: date-time + nullable: true + description: Bloqueio aplicado quando o ADN retornou rate limit. + webhookUrl: + type: string + format: uri + nullable: true + isAutomaticManifestationEnabled: + type: boolean + automaticManifestationDelaySeconds: + type: integer + description: Delay (s) antes de manifestar automaticamente (0–604800 = 7 dias). + deactivationReason: + type: string + nullable: true + description: Razão da última desativação automática. + deactivatedAt: + type: string + format: date-time + nullable: true + createdAt: + type: string + format: date-time + updatedAt: + type: string + format: date-time + example: + id: 5f4d4cee0a8b8e2c3a1bcd11 + name: Empresa Prestadora SA + environment: Production + isActive: true + initialNsu: 0 + currentNsu: 1234 + maxAvailableNsu: 1280 + lastExecutedAt: '2026-05-07T11:30:00Z' + rateLimitedUntil: null + webhookUrl: https://meusistema.com/webhooks/nfse-inbound + isAutomaticManifestationEnabled: false + automaticManifestationDelaySeconds: 0 + deactivationReason: null + deactivatedAt: null + createdAt: '2026-04-10T12:34:56Z' + updatedAt: '2026-05-07T11:30:00Z' + NFSeCompanyCollectionResource: + type: object + description: Listagem paginada de empresas inbound NFS-e. + properties: + totalResults: + type: integer + format: int64 + nullable: true + description: Total geral (apenas quando hasTotals=true). + totalPages: + type: integer + nullable: true + page: + type: integer + nullable: true + description: Página atual (1-based). + companies: + type: array + items: + $ref: '#/components/schemas/NFSeCompanyResource' + example: + totalResults: 2 + totalPages: 1 + page: 1 + companies: + - id: 5f4d4cee0a8b8e2c3a1bcd11 + name: Empresa Prestadora SA + environment: Production + isActive: true + initialNsu: 0 + currentNsu: 1234 + maxAvailableNsu: 1280 + lastExecutedAt: '2026-05-07T11:30:00Z' + rateLimitedUntil: null + webhookUrl: https://meusistema.com/webhooks/nfse-inbound + isAutomaticManifestationEnabled: false + automaticManifestationDelaySeconds: 0 + deactivationReason: null + deactivatedAt: null + createdAt: '2026-04-10T12:34:56Z' + updatedAt: '2026-05-07T11:30:00Z' + NFSeCreateInboundCompanyRequest: + type: object + description: Cadastro de uma nova empresa para captura inbound NFS-e. + required: + - companyId + - initialNsu + properties: + companyId: + type: string + description: CompanyId do TaxPayers. + initialNsu: + type: integer + format: int64 + minimum: 0 + description: NSU inicial (0 para começar do início). + webhookUrl: + type: string + format: uri + nullable: true + description: URL HTTPS válida quando informada (rejeitada se HTTP). + isAutomaticManifestationEnabled: + type: boolean + default: false + automaticManifestationDelaySeconds: + type: integer + minimum: 0 + maximum: 604800 + default: 0 + description: Delay em segundos antes da manifestação automática. Máximo 604800 (7 dias). + example: + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + initialNsu: 0 + webhookUrl: https://meusistema.com/webhooks/nfse-inbound + isAutomaticManifestationEnabled: false + automaticManifestationDelaySeconds: 0 + NFSeUpdateInboundCompanyRequest: + type: object + description: Atualização parcial — somente os campos enviados são alterados. + properties: + webhookUrl: + type: string + format: uri + nullable: true + isAutomaticManifestationEnabled: + type: boolean + automaticManifestationDelaySeconds: + type: integer + minimum: 0 + maximum: 604800 + isActive: + type: boolean + description: Reativação manual quando true. + example: + webhookUrl: https://meusistema.com/webhooks/nfse-inbound-v2 + isAutomaticManifestationEnabled: true + automaticManifestationDelaySeconds: 86400 + isActive: true + NFSeResetNsuRequest: + type: object + description: Redefine o NSU corrente da empresa para reprocessamento. + required: + - nsu + properties: + nsu: + type: integer + format: int64 + minimum: 0 + description: Novo `currentNsu`. Use com cautela — documentos entre o novo NSU e o anterior serão re-emitidos. + example: + nsu: 1000 + NFSeDocumentResource: + type: object + description: Documento NFS-e capturado do ADN (NFS-e, DPS, Evento ou PRE). + properties: + id: + type: string + companyId: + type: string + nsu: + type: integer + format: int64 + type: + type: string + enum: + - None + - Dps + - EventRegistrationRequest + - serviceInvoice + - Event + - Cnc + description: 'Tipo do documento emitido no payload (output). **Breaking change 2026-05-08**: + + o valor para NFS-e principal foi renomeado de `Nfse` para `serviceInvoice` + + (alinhamento com o SKU `ServiceInvoiceInbound` de billing e com o webhook). + + Demais valores preservam o nome do enum `NFSeDocumentType`. Para o query param + + de filtragem (input), continue usando `Nfse` — o renaming aplica-se apenas ao + + valor emitido no response. + + ' + eventType: + type: string + nullable: true + description: Sub-tipo legível (ex. Cancelamento). + eventCode: + type: string + nullable: true + description: tpEvento do XML (ex. 101101). Null para NFS-e principal. + substituteAccessKey: + type: string + nullable: true + description: Quando o documento substitui outro (carta de correção + etc).: null + accessKey: + type: string + description: Chave de acesso (50 dígitos). + generatedOn: + type: string + format: date-time + description: Geração do documento na origem. + issuedOn: + type: string + format: date-time + nullable: true + description: Data de competência ou emissão. + provider: + $ref: '#/components/schemas/NFSeParticipantResource' + borrower: + $ref: '#/components/schemas/NFSeParticipantResource' + servicesAmount: + type: number + format: decimal + nullable: true + description: Valor total dos serviços. + issueCityCode: + type: string + nullable: true + description: Município emissor (IBGE 7 dígitos). + serviceCode: + type: string + nullable: true + description: Item da lista de serviços (LC 116/03). + description: + type: string + nullable: true + description: Descrição livre do serviço. + accrualOn: + type: string + nullable: true + description: Competência YYYY-MM (ex. 2026-04). + environment: + type: string + enum: + - Production + - Development + status: + type: string + enum: + - Pending + - Processed + - Failed + - PdfPending + - PdfFailed + description: 'Estado de processamento — `Processed`/`PdfPending`/`PdfFailed` indicam que + + os metadados foram processados (PDF é gerado em segundo plano). + + ' + webhookStatus: + type: string + enum: + - Pending + - Delivered + - Failed + - DefinitivelyFailed + description: 'Estado da entrega do webhook — `DefinitivelyFailed` após esgotar as tentativas. + + ' + xmlSizeBytes: + type: integer + format: int64 + hasPdf: + type: boolean + description: Se o DANFSe está disponível para download. + relatedEventIds: + type: array + items: + type: string + description: IDs de eventos vinculados (cancelamento, manifestação, etc). + createdAt: + type: string + format: date-time + example: + id: 65fa2c11abc1234567890def + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + nsu: 1234 + type: serviceInvoice + eventType: null + eventCode: null + substituteAccessKey: null + accessKey: '12345678901234567890123456789012345678901234567890' + generatedOn: '2026-05-06T13:30:00Z' + issuedOn: '2026-05-06T13:25:00Z' + provider: + federalTaxNumber: '98765432000180' + name: Empresa Prestadora SA + cityCode: '3550308' + state: SP + borrower: + federalTaxNumber: '12345678000195' + name: Tomador Exemplo SA + cityCode: '3304557' + state: RJ + servicesAmount: 1500.0 + issueCityCode: '3550308' + serviceCode: '1.05' + description: Licenciamento ou cessao de direito de uso de software. + accrualOn: 2026-05 + environment: Production + status: Processed + webhookStatus: Delivered + xmlSizeBytes: 8542 + hasPdf: true + relatedEventIds: [] + createdAt: '2026-05-06T13:30:05Z' + NFSeDocumentDetailResource: + description: 'Detalhamento de um documento NFS-e — `NFSeDocumentResource` + telemetria + + de webhook, manifestação e atualização. + + ' + allOf: + - $ref: '#/components/schemas/NFSeDocumentResource' + - type: object + properties: + intermediary: + $ref: '#/components/schemas/NFSeParticipantResource' + failureReason: + type: string + nullable: true + description: Razão da última falha quando status=Failed. + webhookAttempts: + type: integer + description: Número total de tentativas de entrega. + webhookDeliveredAt: + type: string + format: date-time + nullable: true + webhookFirstAttemptAt: + type: string + format: date-time + nullable: true + reprocessCount: + type: integer + description: Quantas vezes o documento foi reenfileirado manualmente. + manifestationScheduledAt: + type: string + format: date-time + nullable: true + description: Quando a manifestação automática está agendada. + manifestedAt: + type: string + format: date-time + nullable: true + updatedAt: + type: string + format: date-time + example: + id: 65fa2c11abc1234567890def + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + nsu: 1234 + type: serviceInvoice + eventType: null + eventCode: null + substituteAccessKey: null + accessKey: '12345678901234567890123456789012345678901234567890' + generatedOn: '2026-05-06T13:30:00Z' + issuedOn: '2026-05-06T13:25:00Z' + provider: + federalTaxNumber: '98765432000180' + name: Empresa Prestadora SA + cityCode: '3550308' + state: SP + borrower: + federalTaxNumber: '12345678000195' + name: Tomador Exemplo SA + cityCode: '3304557' + state: RJ + intermediary: null + servicesAmount: 1500.0 + issueCityCode: '3550308' + serviceCode: '1.05' + description: Licenciamento ou cessao de direito de uso de software. + accrualOn: 2026-05 + environment: Production + status: Processed + webhookStatus: Delivered + xmlSizeBytes: 8542 + hasPdf: true + relatedEventIds: [] + createdAt: '2026-05-06T13:30:05Z' + failureReason: null + webhookAttempts: 1 + webhookDeliveredAt: '2026-05-06T13:30:08Z' + webhookFirstAttemptAt: '2026-05-06T13:30:07Z' + reprocessCount: 0 + manifestationScheduledAt: null + manifestedAt: null + updatedAt: '2026-05-06T13:30:08Z' + NFSeDocumentCollectionResource: + type: object + description: Listagem paginada de documentos NFS-e capturados. + properties: + totalResults: + type: integer + format: int64 + nullable: true + description: Total geral (apenas quando hasTotals=true). + totalPages: + type: integer + nullable: true + page: + type: integer + nullable: true + documents: + type: array + items: + $ref: '#/components/schemas/NFSeDocumentResource' + example: + totalResults: 1 + totalPages: 1 + page: 1 + documents: + - id: 65fa2c11abc1234567890def + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + nsu: 1234 + type: serviceInvoice + eventType: null + eventCode: null + substituteAccessKey: null + accessKey: '12345678901234567890123456789012345678901234567890' + generatedOn: '2026-05-06T13:30:00Z' + issuedOn: '2026-05-06T13:25:00Z' + provider: + federalTaxNumber: '98765432000180' + name: Empresa Prestadora SA + cityCode: '3550308' + state: SP + borrower: + federalTaxNumber: '12345678000195' + name: Tomador Exemplo SA + cityCode: '3304557' + state: RJ + servicesAmount: 1500.0 + issueCityCode: '3550308' + serviceCode: '1.05' + description: Licenciamento ou cessao de direito de uso de software. + accrualOn: 2026-05 + environment: Production + status: Processed + webhookStatus: Delivered + xmlSizeBytes: 8542 + hasPdf: true + relatedEventIds: [] + createdAt: '2026-05-06T13:30:05Z' + NFSeSubmitManifestationEventRequest: + type: object + description: Dados opcionais da manifestação do tomador (ciência ou rejeição). + properties: + reasonCode: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 9 + description: 'Obrigatório para `eventCode=203206` (Rejeição); ignorado para `203202` + + (Confirmação). Valores: 1=Duplicata, 2=Já emitida pelo tomador, + + 3=Sem fato gerador, 4=Erro de responsabilidade tributária, + + 5=Erro de valor/serviço/data, 9=Outros. + + ' + justification: + type: string + maxLength: 255 + description: xMotivo opcional. Limite 255 chars (XSD SEFIN Nacional). + example: + reasonCode: 2 + justification: NFS-e foi emitida em duplicidade pelo prestador. + NFSeManifestationEventResource: + type: object + description: Evento de manifestação do tomador submetido à SEFIN Nacional. + properties: + id: + type: string + companyId: + type: string + accessKey: + type: string + description: Chave da NFS-e relacionada (50 dígitos). + eventCode: + type: integer + enum: + - 203202 + - 203206 + description: 203202 = Confirmação + 203206 = Rejeição.: null + reasonCode: + type: integer + nullable: true + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 9 + justification: + type: string + nullable: true + status: + type: string + enum: + - Pending + - Accepted + - Rejected + - Failed + description: Estado do evento — começa em `Pending`, transita para `Accepted`/`Rejected` após retorno da SEFIN, ou `Failed` em caso de erro irrecuperável (`NFSeManifestationEventStatus`). + environment: + type: string + enum: + - Production + - Development + createdAt: + type: string + format: date-time + submittedAt: + type: string + format: date-time + nullable: true + acceptedAt: + type: string + format: date-time + nullable: true + errorCode: + type: string + nullable: true + description: cStat retornado pela SEFIN quando status=Rejected/Failed. + errorMessage: + type: string + nullable: true + description: xMotivo retornado pela SEFIN. + example: + id: 65fa3a44abc1234567890aaa + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + accessKey: '12345678901234567890123456789012345678901234567890' + eventCode: 203202 + reasonCode: null + justification: null + status: Pending + environment: Production + createdAt: '2026-05-06T14:00:00Z' + submittedAt: null + acceptedAt: null + errorCode: null + errorMessage: null + NFSeManifestationEventDetailResource: + description: '`NFSeManifestationEventResource` + payload XML do request (`pedidoRegistroEvento`) + + e response da SEFIN, ambos comprimidos em GZip + Base64 para inspeção. + + ' + allOf: + - $ref: '#/components/schemas/NFSeManifestationEventResource' + - type: object + properties: + requestXmlGZipB64: + type: string + description: pedidoRegistroEvento assinado, GZip + Base64. + responseXmlGZipB64: + type: string + nullable: true + description: Resposta da SEFIN Nacional, GZip + Base64. + example: + id: 65fa3a44abc1234567890aaa + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + accessKey: '12345678901234567890123456789012345678901234567890' + eventCode: 203202 + reasonCode: null + justification: null + status: Accepted + environment: Production + createdAt: '2026-05-06T14:00:00Z' + submittedAt: '2026-05-06T14:00:02Z' + acceptedAt: '2026-05-06T14:00:03Z' + errorCode: null + errorMessage: null + requestXmlGZipB64: H4sIAAAAAAAA... + responseXmlGZipB64: H4sIAAAAAAAB... + NFSeManifestationEventCollectionResource: + type: object + description: Lista de eventos de manifestação para uma chave de acesso. + properties: + items: + type: array + items: + $ref: '#/components/schemas/NFSeManifestationEventResource' + example: + items: + - id: 65fa3a44abc1234567890aaa + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + accessKey: '12345678901234567890123456789012345678901234567890' + eventCode: 203202 + reasonCode: null + justification: null + status: Accepted + environment: Production + createdAt: '2026-05-06T14:00:00Z' + submittedAt: '2026-05-06T14:00:02Z' + acceptedAt: '2026-05-06T14:00:03Z' + errorCode: null + errorMessage: null + NFSeNotificationResource: + type: object + description: Notificação operacional (manutenção/severidade) para uma empresa inbound. + properties: + id: + type: string + companyId: + type: string + nullable: true + description: Null para notificações globais. + type: + type: string + description: Tipo da notificação (ex. RateLimited, Deactivated, AdnDown). + severity: + type: string + enum: + - Info + - Warning + - Critical + title: + type: string + description: + type: string + documentId: + type: string + nullable: true + nsu: + type: integer + format: int64 + nullable: true + createdAt: + type: string + format: date-time + example: + id: 65fa4b55abc1234567890bbb + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + type: RateLimited + severity: Warning + title: ADN aplicou rate limit + description: Captura pausada por 30 minutos por excesso de requisições. + documentId: null + nsu: null + createdAt: '2026-05-07T11:00:00Z' + NFSeNotificationCollectionResource: + type: object + description: Listagem paginada de notificações de manutenção. + properties: + totalResults: + type: integer + format: int64 + nullable: true + totalPages: + type: integer + nullable: true + page: + type: integer + nullable: true + notifications: + type: array + items: + $ref: '#/components/schemas/NFSeNotificationResource' + example: + totalResults: 1 + totalPages: 1 + page: 1 + notifications: + - id: 65fa4b55abc1234567890bbb + companyId: 5f4d4cee0a8b8e2c3a1bcd11 + type: RateLimited + severity: Warning + title: ADN aplicou rate limit + description: Captura pausada por 30 minutos por excesso de requisições. + documentId: null + nsu: null + createdAt: '2026-05-07T11:00:00Z' + NFSeFetchNowRequest: + type: object + description: Solicita disparo imediato da captura para uma empresa (admin). + properties: + forcedStartNsu: + type: integer + format: int64 + minimum: 0 + nullable: true + description: 'Se informado, a captura inicia a partir deste NSU em vez do + + `currentNsu` da empresa. Uso típico: reprocessar uma janela + + específica de documentos. + + ' + example: + forcedStartNsu: 1000 + NFSeCompanyOpsViewResource: + type: object + description: Visão operacional retornada por `/maintenance/statistics` (role Management). + properties: + id: + type: string + accountId: + type: string + name: + type: string + isActive: + type: boolean + currentNsu: + type: integer + format: int64 + maxAvailableNsu: + type: integer + format: int64 + consecutiveFailures: + type: integer + deactivationReason: + type: string + nullable: true + lastExecutedAt: + type: string + format: date-time + nullable: true + rateLimitedUntil: + type: string + format: date-time + nullable: true + documentsTotal: + type: integer + format: int64 + documentsProcessed: + type: integer + format: int64 + documentsFailed: + type: integer + format: int64 + documentsPdfPending: + type: integer + format: int64 + webhooksDelivered: + type: integer + format: int64 + webhooksFailed: + type: integer + format: int64 + example: + id: 5f4d4cee0a8b8e2c3a1bcd11 + accountId: acc_5f4d4cee0a8b + name: Empresa Prestadora SA + isActive: true + currentNsu: 1234 + maxAvailableNsu: 1280 + consecutiveFailures: 0 + deactivationReason: null + lastExecutedAt: '2026-05-07T11:30:00Z' + rateLimitedUntil: null + documentsTotal: 1234 + documentsProcessed: 1230 + documentsFailed: 4 + documentsPdfPending: 2 + webhooksDelivered: 1228 + webhooksFailed: 6 + AsyncAcceptedResource: + type: object + description: 'Resposta padrão de operações assíncronas (HTTP 202). Contém uma + + mensagem informativa e identificadores de correlação para o cliente + + acompanhar o processamento (via `GET` correspondente ou webhook). + + ' + properties: + message: + type: string + documentId: + type: string + description: ID do documento (presente em /reprocess e /resend-webhook). + companyId: + type: string + description: ID da empresa (presente em /fetch-now). + example: + message: Documento reenfileirado para reprocessamento. + documentId: 65fa2c11abc1234567890def diff --git a/openapi/product-invoice-rtc-v1.yaml b/openapi/product-invoice-rtc-v1.yaml index 5479204..51e768a 100644 --- a/openapi/product-invoice-rtc-v1.yaml +++ b/openapi/product-invoice-rtc-v1.yaml @@ -13,10 +13,17 @@ info: Esta adequação de leiaute contempla até a Nota Técnica **NT_2025.002_v1.30_RTC_NF-e_IBS_CBS_IS**. - > **Atenção** + > **Atenção** > _Sujeito a alterações mediante notas técnicas e processos de homologação._ + + ### Nota de Crédito por recusa — consulta (read-model) + + Esta especificação cobre a **emissão** (finNFe=5/6, `creditType`/`debitType`). Para **consultar** as + Notas de Crédito por recusa emitidas contra uma NF-e (campo `creditInvoicesIssuedAgainst` e os + endpoints `GET .../credit-invoices` e `POST .../credit-invoice-links`), consulte a referência + **Nota Fiscal de Produto (V3)**. servers: - - url: https://api.nfse.io/ + - url: https://api.nfse.io description: Nota Fiscal de Produto/Consumidor (RTC). tags: - name: Nota Fiscal de Produto/Consumidor (RTC) @@ -244,7 +251,7 @@ paths: printType: "NFeNormalPortrait" purposeType: "Normal" # Finalidade da emissão debitType: "FinesAndInterest" - creditType: "IbsPresumedCreditAppropriationZfm" + creditType: "RefusedDeliveryTotalOrNotFound" consumerType: "Normal" presenceType: "Internet" contingencyOn: "2025-10-28T09:00:00-03:00" @@ -1378,33 +1385,27 @@ components: type: "string" nullable: true description: | - Tipo de Nota de Crédito (tpNFCredito). + Tipo de Nota de Crédito (tpNFCredito). Obrigatório quando `purposeType=CreditInvoice`. Valores possíveis: - - `FinesAndInterest`: Multa e juros - - `IbsPresumedCreditAppropriationZfm`: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM - - `ReturnDeliveryRefusedOrNotFound`: Retorno por recusa na entrega ou não localização do destinatário - - `ValueReduction`: Redução de valores - - `TransferCreditSuccession`: Transferência de crédito na sucessão + - `RefusedDeliveryTotalOrNotFound`: Retorno por Recusa TOTAL na Entrega ou por Não Localização do Destinatário (tpNFCredito=03) + - `RefusedDeliveryPartial`: Retorno por Recusa PARCIAL na Entrega (tpNFCredito=06 — Ajuste SINIEF 8/26; exige referência por item em `items[].referencedDFe`) enum: - - "FinesAndInterest" - - "IbsPresumedCreditAppropriationZfm" - - "ReturnDeliveryRefusedOrNotFound" - - "ValueReduction" - - "TransferCreditSuccession" + - "RefusedDeliveryTotalOrNotFound" + - "RefusedDeliveryPartial" DebitType: type: "string" nullable: true description: | - Tipo de Nota de Débito (tpNFDebito). + Tipo de Nota de Débito (tpNFDebito). Obrigatório quando `purposeType=DebitInvoice`. Valores possíveis: - - `TransferCreditsToCooperatives`: Transferência de créditos para cooperativas - - `CancelCreditsExemptImmuneSales`: Cancelamento de créditos por vendas isentas/imunes - - `UnprocessedInvoicesDebits`: Débitos de faturas não processadas no cálculo - - `FinesAndInterest`: Multas e juros - - `TransferInheritanceCredit`: Transferência de crédito de herança - - `AdvancePayment`: Pagamento antecipado - - `InventoryLoss`: Perda de estoque - - `SnDisqualification`: Desenquadramento do Simples Nacional + - `TransferCreditsToCooperatives` (01): Transferência de créditos para cooperativas + - `CancelCreditsExemptImmuneSales` (02): Cancelamento de créditos por vendas isentas/imunes + - `UnprocessedInvoicesDebits` (03): Débitos de faturas não processadas + - `FinesAndInterest` (04): Multas e juros + - `TransferInheritanceCredit` (05): Transferência de crédito na sucessão + - `AdvancePayment` (06): Pagamento antecipado + - `InventoryLoss` (07): Perda de estoque + - `SnDisqualification` (08): Desenquadramento do Simples Nacional enum: - "TransferCreditsToCooperatives" - "CancelCreditsExemptImmuneSales" @@ -4270,6 +4271,8 @@ components: - "Complement" - "Adjustment" - "Devolution" # Devolução + - "CreditInvoice" # Nota de Crédito (finNFe=5) + - "DebitInvoice" # Nota de Débito (finNFe=6) default: "Normal" description: | Finalidade da emissão da NF-e (finNFe). @@ -4279,6 +4282,8 @@ components: - `Complement`: NF-e complementar - `Adjustment`: NF-e de ajuste - `Devolution`: Devolução de mercadoria + - `CreditInvoice`: Nota de Crédito (finNFe=5, Ajuste SINIEF 49/25) — requer `creditType` + - `DebitInvoice`: Nota de Débito (finNFe=6, Ajuste SINIEF 49/25) — requer `debitType` QueueEventResource: type: "object" properties: diff --git a/src/Generated/ConsultaCnpjV3/AddressResourceItem.php b/src/Generated/ConsultaCnpjV3/AddressResourceItem.php new file mode 100644 index 0000000..9f145a0 --- /dev/null +++ b/src/Generated/ConsultaCnpjV3/AddressResourceItem.php @@ -0,0 +1,29 @@ +|null $phones + * @param list|null $economicActivities + * @param list|null $partners + * @param list|null $taxRegimeHistory + */ +final readonly class LegalPersonResourceV3Item +{ + public function __construct( + public ?string $tradeName = null, + public ?string $name = null, + public ?string $federalTaxNumber = null, + public ?LegalEntitySize $size = null, + public ?string $openedOn = null, + public ?AddressResourceItem $address = null, + public ?array $phones = null, + public ?string $statusOn = null, + public ?LegalEntityStatus $status = null, + public ?string $email = null, + public ?string $responsableEntity = null, + public ?string $specialStatus = null, + public ?string $specialStatusOn = null, + public ?string $issuedOn = null, + public ?string $statusReason = null, + public ?float $shareCapital = null, + public ?array $economicActivities = null, + public ?LegalEntityNatureResource $legalNature = null, + public ?array $partners = null, + public ?string $registrationUnit = null, + public ?UnitType $unit = null, + public ?TaxRegimes $taxRegime = null, + public ?array $taxRegimeHistory = null, + ) {} +} diff --git a/src/Generated/ConsultaCnpjV3/PartnerResource.php b/src/Generated/ConsultaCnpjV3/PartnerResource.php new file mode 100644 index 0000000..5e79c19 --- /dev/null +++ b/src/Generated/ConsultaCnpjV3/PartnerResource.php @@ -0,0 +1,17 @@ +|null $stateTaxes + */ +final readonly class StateTaxResourceItemV3 +{ + public function __construct( + public ?string $tradeName = null, + public ?string $name = null, + public ?string $federalTaxNumber = null, + public ?string $createdOn = null, + public ?TaxRegimeType $taxRegime = null, + public ?LegalNature $legalNature = null, + public ?string $fiscalUnit = null, + public ?string $createdUnit = null, + public ?string $checkCode = null, + public ?array $stateTaxes = null, + ) {} +} diff --git a/src/Generated/ConsultaCnpjV3/StateTaxResourceV3.php b/src/Generated/ConsultaCnpjV3/StateTaxResourceV3.php new file mode 100644 index 0000000..a759f93 --- /dev/null +++ b/src/Generated/ConsultaCnpjV3/StateTaxResourceV3.php @@ -0,0 +1,16 @@ +|null $xmlAuthorized + * @param list|null $taxDocumentsReference + * @param list|null $advancePayment + * @param list|null $taxpayerComments + * @param list|null $referencedProcess + */ +final readonly class AdditionalInformationResource +{ + public function __construct( + public ?string $fisco = null, + public ?string $taxpayer = null, + public ?array $xmlAuthorized = null, + public ?string $effort = null, + public ?string $order = null, + public ?string $contract = null, + public ?array $taxDocumentsReference = null, + public ?array $advancePayment = null, + public ?array $taxpayerComments = null, + public ?array $referencedProcess = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/AddressResource.php b/src/Generated/NfConsumidorV3/AddressResource.php new file mode 100644 index 0000000..94cc320 --- /dev/null +++ b/src/Generated/NfConsumidorV3/AddressResource.php @@ -0,0 +1,27 @@ +|null $duplicates + */ +final readonly class BillingResource +{ + public function __construct( + public ?BillResource $bill = null, + public ?array $duplicates = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/BuyerResource.php b/src/Generated/NfConsumidorV3/BuyerResource.php new file mode 100644 index 0000000..20ba685 --- /dev/null +++ b/src/Generated/NfConsumidorV3/BuyerResource.php @@ -0,0 +1,29 @@ +|null $errors + */ +final readonly class ErrorsResource +{ + public function __construct( + public ?array $errors = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/ExemptReason.php b/src/Generated/NfConsumidorV3/ExemptReason.php new file mode 100644 index 0000000..ecadb13 --- /dev/null +++ b/src/Generated/NfConsumidorV3/ExemptReason.php @@ -0,0 +1,19 @@ +|null $events + */ +final readonly class InvoiceEventsResource +{ + public function __construct( + public ?array $events = null, + public ?bool $hasMore = null, + public ?string $id = null, + public ?string $accountId = null, + public ?string $companyId = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/InvoiceEventsResourceBase.php b/src/Generated/NfConsumidorV3/InvoiceEventsResourceBase.php new file mode 100644 index 0000000..e250d78 --- /dev/null +++ b/src/Generated/NfConsumidorV3/InvoiceEventsResourceBase.php @@ -0,0 +1,20 @@ +|null $events + */ +final readonly class InvoiceEventsResourceBase +{ + public function __construct( + public ?array $events = null, + public ?bool $hasMore = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/InvoiceItemResource.php b/src/Generated/NfConsumidorV3/InvoiceItemResource.php new file mode 100644 index 0000000..dca57d7 --- /dev/null +++ b/src/Generated/NfConsumidorV3/InvoiceItemResource.php @@ -0,0 +1,55 @@ +|null $items + */ +final readonly class InvoiceItemsResource +{ + public function __construct( + public ?string $accountId = null, + public ?string $companyId = null, + public ?string $id = null, + public ?array $items = null, + public ?bool $hasMore = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/InvoiceResource.php b/src/Generated/NfConsumidorV3/InvoiceResource.php new file mode 100644 index 0000000..3e127af --- /dev/null +++ b/src/Generated/NfConsumidorV3/InvoiceResource.php @@ -0,0 +1,43 @@ +|null $payment + */ +final readonly class InvoiceResource +{ + public function __construct( + public ?string $id = null, + public ?int $serie = null, + public ?int $number = null, + public ?InvoiceStatus $status = null, + public ?AuthorizationResource $authorization = null, + public ?ContingencyDetails $contingencyDetails = null, + public ?string $operationNature = null, + public ?string $createdOn = null, + public ?string $modifiedOn = null, + public ?string $operationOn = null, + public ?OperationType $operationType = null, + public ?EnvironmentType $environmentType = null, + public ?PurposeType $purposeType = null, + public ?IssuerResource $issuer = null, + public ?BuyerResource $buyer = null, + public ?TotalResource $totals = null, + public ?TransportInformationResource $transport = null, + public ?AdditionalInformationResource $additionalInformation = null, + public ?ExportResource $export = null, + public ?BillingResource $billing = null, + public ?array $payment = null, + public ?IntermediateResource $transactionIntermediate = null, + public ?DeliveryInformationResource $delivery = null, + public ?WithdrawalInformationResource $withdrawal = null, + public ?InvoiceEventsResourceBase $lastEvents = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/InvoiceStatus.php b/src/Generated/NfConsumidorV3/InvoiceStatus.php new file mode 100644 index 0000000..b440478 --- /dev/null +++ b/src/Generated/NfConsumidorV3/InvoiceStatus.php @@ -0,0 +1,22 @@ +|null $payment + */ +final readonly class InvoiceWithoutEventsResource +{ + public function __construct( + public ?string $id = null, + public ?int $serie = null, + public ?int $number = null, + public ?InvoiceStatus $status = null, + public ?AuthorizationResource $authorization = null, + public ?ContingencyDetails $contingencyDetails = null, + public ?string $operationNature = null, + public ?string $createdOn = null, + public ?string $modifiedOn = null, + public ?string $operationOn = null, + public ?OperationType $operationType = null, + public ?EnvironmentType $environmentType = null, + public ?PurposeType $purposeType = null, + public ?IssuerResource $issuer = null, + public ?BuyerResource $buyer = null, + public ?TotalResource $totals = null, + public ?TransportInformationResource $transport = null, + public ?AdditionalInformationResource $additionalInformation = null, + public ?ExportResource $export = null, + public ?BillingResource $billing = null, + public ?array $payment = null, + public ?IntermediateResource $transactionIntermediate = null, + public ?DeliveryInformationResource $delivery = null, + public ?WithdrawalInformationResource $withdrawal = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/IssuerFromRequestResource.php b/src/Generated/NfConsumidorV3/IssuerFromRequestResource.php new file mode 100644 index 0000000..fe4d586 --- /dev/null +++ b/src/Generated/NfConsumidorV3/IssuerFromRequestResource.php @@ -0,0 +1,16 @@ +|null $paymentDetail + */ +final readonly class PaymentResource +{ + public function __construct( + public ?array $paymentDetail = null, + public ?float $payBack = null, + ) {} +} diff --git a/src/Generated/NfConsumidorV3/PaymentType.php b/src/Generated/NfConsumidorV3/PaymentType.php new file mode 100644 index 0000000..587ea9e --- /dev/null +++ b/src/Generated/NfConsumidorV3/PaymentType.php @@ -0,0 +1,15 @@ +|null $xmlAuthorized + * @param list|null $taxDocumentsReference + * @param list|null $taxpayerComments + * @param list|null $referencedProcess + */ +final readonly class AdditionalInformationResource +{ + public function __construct( + public ?string $fisco = null, + public ?string $taxpayer = null, + public ?array $xmlAuthorized = null, + public ?string $effort = null, + public ?string $order = null, + public ?string $contract = null, + public ?array $taxDocumentsReference = null, + public ?array $taxpayerComments = null, + public ?array $referencedProcess = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/AddressResource.php b/src/Generated/NfProdutoV3/AddressResource.php new file mode 100644 index 0000000..771e79e --- /dev/null +++ b/src/Generated/NfProdutoV3/AddressResource.php @@ -0,0 +1,27 @@ +|null $duplicates + */ +final readonly class BillingResource +{ + public function __construct( + public ?BillResource $bill = null, + public ?array $duplicates = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/BuyerResource.php b/src/Generated/NfProdutoV3/BuyerResource.php new file mode 100644 index 0000000..3cb9981 --- /dev/null +++ b/src/Generated/NfProdutoV3/BuyerResource.php @@ -0,0 +1,29 @@ +|null $errors + */ +final readonly class ErrorsResource +{ + public function __construct( + public ?array $errors = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/ExemptReason.php b/src/Generated/NfProdutoV3/ExemptReason.php new file mode 100644 index 0000000..1f5689d --- /dev/null +++ b/src/Generated/NfProdutoV3/ExemptReason.php @@ -0,0 +1,19 @@ +|null $events + */ +final readonly class InvoiceEventsResourceBase +{ + public function __construct( + public ?array $events = null, + public ?bool $hasMore = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/InvoiceItemResource.php b/src/Generated/NfProdutoV3/InvoiceItemResource.php new file mode 100644 index 0000000..38e8018 --- /dev/null +++ b/src/Generated/NfProdutoV3/InvoiceItemResource.php @@ -0,0 +1,50 @@ +|null $items + */ +final readonly class InvoiceItemsResource +{ + public function __construct( + public ?string $accountId = null, + public ?string $companyId = null, + public ?string $id = null, + public ?array $items = null, + public ?bool $hasMore = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/InvoiceResource.php b/src/Generated/NfProdutoV3/InvoiceResource.php new file mode 100644 index 0000000..f476e47 --- /dev/null +++ b/src/Generated/NfProdutoV3/InvoiceResource.php @@ -0,0 +1,47 @@ +|null $creditInvoicesIssuedAgainst + * @param list|null $payment + */ +final readonly class InvoiceResource +{ + public function __construct( + public ?string $id = null, + public ?int $serie = null, + public ?int $number = null, + public ?InvoiceStatus $status = null, + public ?AuthorizationResource $authorization = null, + public ?ContingencyDetails $contingencyDetails = null, + public ?string $operationNature = null, + public ?string $createdOn = null, + public ?string $modifiedOn = null, + public ?string $operationOn = null, + public ?OperationType $operationType = null, + public ?EnvironmentType $environmentType = null, + public ?PurposeType $purposeType = null, + public ?CreditType $creditType = null, + public ?DebitType $debitType = null, + public ?array $creditInvoicesIssuedAgainst = null, + public ?IssuerResource $issuer = null, + public ?BuyerResource $buyer = null, + public ?TotalResource $totals = null, + public ?TransportInformationResource $transport = null, + public ?AdditionalInformationResource $additionalInformation = null, + public ?ExportResource $export = null, + public ?BillingResource $billing = null, + public ?array $payment = null, + public ?IntermediateResource $transactionIntermediate = null, + public ?DeliveryInformationResource $delivery = null, + public ?WithdrawalInformationResource $withdrawal = null, + public ?InvoiceEventsResourceBase $lastEvents = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/InvoiceStatus.php b/src/Generated/NfProdutoV3/InvoiceStatus.php new file mode 100644 index 0000000..a4eaa29 --- /dev/null +++ b/src/Generated/NfProdutoV3/InvoiceStatus.php @@ -0,0 +1,25 @@ +|null $creditInvoicesIssuedAgainst + * @param list|null $payment + */ +final readonly class InvoiceWithoutEventsResource +{ + public function __construct( + public ?string $id = null, + public ?int $serie = null, + public ?int $number = null, + public ?InvoiceStatus $status = null, + public ?AuthorizationResource $authorization = null, + public ?ContingencyDetails $contingencyDetails = null, + public ?string $operationNature = null, + public ?string $createdOn = null, + public ?string $modifiedOn = null, + public ?string $operationOn = null, + public ?OperationType $operationType = null, + public ?EnvironmentType $environmentType = null, + public ?PurposeType $purposeType = null, + public ?CreditType $creditType = null, + public ?DebitType $debitType = null, + public ?array $creditInvoicesIssuedAgainst = null, + public ?IssuerResource $issuer = null, + public ?BuyerResource $buyer = null, + public ?TotalResource $totals = null, + public ?TransportInformationResource $transport = null, + public ?AdditionalInformationResource $additionalInformation = null, + public ?ExportResource $export = null, + public ?BillingResource $billing = null, + public ?array $payment = null, + public ?IntermediateResource $transactionIntermediate = null, + public ?DeliveryInformationResource $delivery = null, + public ?WithdrawalInformationResource $withdrawal = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/IssuerFromRequestResource.php b/src/Generated/NfProdutoV3/IssuerFromRequestResource.php new file mode 100644 index 0000000..beeebc1 --- /dev/null +++ b/src/Generated/NfProdutoV3/IssuerFromRequestResource.php @@ -0,0 +1,16 @@ + $paymentDetail + */ +final readonly class PaymentResource +{ + public function __construct( + public array $paymentDetail, + public ?float $payBack = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/PaymentType.php b/src/Generated/NfProdutoV3/PaymentType.php new file mode 100644 index 0000000..04ab249 --- /dev/null +++ b/src/Generated/NfProdutoV3/PaymentType.php @@ -0,0 +1,18 @@ +|null $events + */ +final readonly class ProductInvoiceEventsResource +{ + public function __construct( + public ?array $events = null, + public ?bool $hasMore = null, + public ?string $id = null, + public ?string $accountId = null, + public ?string $companyId = null, + ) {} +} diff --git a/src/Generated/NfProdutoV3/ProductInvoiceQueueIssueResource.php b/src/Generated/NfProdutoV3/ProductInvoiceQueueIssueResource.php new file mode 100644 index 0000000..c131fd7 --- /dev/null +++ b/src/Generated/NfProdutoV3/ProductInvoiceQueueIssueResource.php @@ -0,0 +1,45 @@ +