O app tem um novo jeito de enviar e acompanhar lotes, num painel ao lado da lista de notas. Esta página descreve o envio anterior. Por enquanto, ele continua disponível, mas vai ser desligado no futuro, em data ainda a definir. Para ativar o painel e ver como ele funciona, consulte Painel de lotes.
O painel da NFE.io está recebendo uma nova interface e esta documentação está sendo atualizada junto. Alguns nomes de menus e telas podem estar diferentes do que você vê. Em caso de divergência, fale com o suporte.
Como emitir Nota Fiscal Eletrônica de Serviço em Lote
Aqui você entenderá melhor como emitir nota fiscal eletrônica de serviço (NFS-e) em Lote na nossa plataforma, explicado passo-a-passo.
📚 Novo na emissão de NFS-e? Recomendamos ler os conceitos sobre Nota Fiscal de Serviço antes de continuar.
Ao final desse tutorial, você será capaz de:
- Emitir notas fiscais de serviço eletrônica (NFS-e) em lote
Requisitos
A emissão é limitada a 50 linhas por planilha. Com a funcionalidade Emissão de NFS-e em Lote habilitada na assinatura, o limite passa a 1.000 linhas. Para habilitar, fale com o suporte pelo chat ou por [email protected].
Não há custo para essa solicitação.
1. Como emitir
1.1 No menu lateral, clique em Empresas
1.2 No fim da linha da sua empresa, clique no botão de Ações (⋮) e, no grupo NFS-e, escolha Emitir NFS-e em lote.
1.3 Nesse passo a passo você encontrará as instruções necessárias para emitir suas notas fiscais utilizando o excel e como preencher os campos da planilha.
Passo a passo para emitir notas fiscais em lote
2. Passo a passo para montar sua planilha
2.1 Você pode pular caso já saiba como emitir em lote, ou pode clicar em sim e dar continuidade.
2.2 Nessa etapa você deve escolher um dos modelos de planilha que disponibilizamos para realizar as emissões em lote. No modelo básico, os impostos são calculados automaticamente pelo nosso sistema e contém apenas os campos excênciais para a emissão das notas. No modelo avançado, você pode informar os dados de impostos retidos, alíquota de ISS entre outros campos. Os impostos serão calculados de acordo com as alíquotas que você informou.
💡 Dica: Se você não sabe qual código de serviço utilizar, consulte nosso guia Qual código de serviço devo utilizar?
2.3 Aqui você poderá baixar e aprender como preencher o modelo de planilha selecionado anteriormente.
2.4 Nessa etapa você já deve estar com a sua planilha corretamente preenchida. Para importá-la, arraste o arquivo para a área Arraste e solte a planilha aqui (ou clique nela para selecionar o arquivo) e depois clique em Importar. Nós iremos validar todas as informações nela contidas.
2.5 Aguarde um momento enquanto realizamos a validação dos dados. Se estiver tudo correto, você irá ver a seguinte mensagem "Planilha importada com sucesso!". Clique no botão IR PARA EMISSÃO para continuar com a emissão das suas notas.
3. Emitir em lote
Nessa tela temos uma listagem com as notas fiscais de sua planilha. Aqui você poderá revisar as informações das notas, selecionar quais serão enviadas para emissão e acompanhar o status da sua emissão.
3.1 Para selecionar, clique na caixa de seleção na primeira coluna. Você poderá selecionar todas de uma vez clicando na primeira caixa de seleção ou poderá selecionar manualmente quais deseja.
3.2 Para emitir, clique no botão Emitir em lote e aguarde até que todas sejam emitidas.
Veja esse tutorial que montamos para você!
4. Planilha básica
Veja abaixo algumas regras importantes para alguns campos específicos.
- Codigo_Servico: código do serviço no município (
cityServiceCode). Cada prefeitura possui sua própria tabela de códigos de serviço. - Codigo_Servico_Federal: código federal do serviço (
federalServiceCode) conforme Lei Complementar 116 (máx. 5 caracteres). Saiba mais. - Descricao: descrição detalhada do serviço prestado (máx. 2000 caracteres).
- NBS: código da Nomenclatura Brasileira de Serviços (máx. 9 dígitos). Campo obrigatório na API. Consulte a tabela de códigos NBS aqui.
- CPF_CNPJ: pode ser preenchido no formato padrão ou somente números.
- Email: caso queira enviar para mais de um email, basta separá-los com vírgula. (Ex: [email protected], [email protected]).
- Valor: pode ser preenchido no padrão brasileiro ou americano. (Ex: 1.000,50 ou 1000.50).
- Endereco_Pais: Sigla do País no padrão ISO 3166-1. (Ex: BRA, USA, ARG). Mais em Wikipedia - ISO 3166-1.
- Endereco_Cep: pode ser preenchido no formato padrão ou somente números.
- Data_competencia: a data de competência deve ser preenchida apenas para notas retroativas e deve seguir o seguinte formato: YYYY-MM-DD (ano-mês-dia).
⚠️ Importante: O nome de cada coluna na planilha deve ser exatamente igual ao descrito na coluna "Campo/Coluna" das tabelas abaixo. Qualquer diferença (espaços, acentos, maiúsculas/minúsculas diferentes) fará com que o sistema não reconheça o campo.
A coluna "Campo na API" é o caminho, no corpo da emissão (POST https://api.nfse.io/v2/companies/{company_id}/serviceinvoices), do campo que recebe o valor da coluna, para quem quiser comparar com a referência da API. O ponto separa os níveis do objeto (borrower.address.city.code é code dentro de city, dentro de address, dentro de borrower) e [] indica um item de lista. Nos grupos de documento de dedução e de reembolso, a planilha envia um único documento por nota; em Info_Adicional_Itens_Pedido, cada item separado vira um elemento da lista.
🎨 Convenção de cores dos cabeçalhos: na planilha, cabeçalhos em vermelho indicam campos obrigatórios em toda linha. Cabeçalhos em cinza indicam campos opcionais no nível da nota; alguns desses campos podem se tornar condicionalmente obrigatórios quando o grupo ao qual pertencem é utilizado (ex:
Obra_Endereco_*,Deducao_Documento_*,Reembolso_Terceiros_Documento_*). Consulte as regras de cada grupo nas seções abaixo.
⚠️ Mantenha as células como Texto: os modelos oficiais já vêm com as colunas formatadas como Texto. Não sobrescreva esse formato ao colar dados (prefira Colar Especial → Valores) ou ao montar sua própria planilha. Caso contrário, o editor pode remover zeros à esquerda ou converter o valor (ex.:
05vira5), gerando erro na emissão.
Campos Obrigatórios (Planilha Básica)
⚠️ Atenção: A obrigatoriedade das informações pode variar de prefeitura para prefeitura.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Codigo_Servico | cityServiceCode | Texto livre | Código do serviço no município. Cada prefeitura possui sua própria tabela de códigos. |
Descricao | description | Texto livre | Descrição detalhada do serviço prestado (máx. 2000 caracteres) |
Valor | servicesAmount | Numérico | Valor total do serviço. Ex: 1000.50 ou 1.000,50 |
NBS | nbsCode | Código NBS | Código da Nomenclatura Brasileira de Serviços (máx. 9 dígitos). Obrigatório em algumas cidades. Consulte a tabela de códigos NBS aqui. |
CPF_CNPJ | borrower.federalTaxNumber | CPF ou CNPJ | CPF ou CNPJ do tomador. Pode ser com ou sem formatação |
Nome | borrower.name | Texto livre | Nome ou Razão Social do tomador |
Endereco_Pais | borrower.address.country | Código ISO 3166-1 | Sigla do país (ex: BRA, USA, ARG) |
Endereco_Cep | borrower.address.postalCode | CEP | CEP do endereço. Com ou sem formatação |
Endereco_Logradouro | borrower.address.street | Texto livre | Nome da rua, avenida, etc. |
Endereco_Numero | borrower.address.number | Texto livre | Número do endereço |
Endereco_Bairro | borrower.address.district | Texto livre | Bairro do endereço |
Endereco_Cidade_Codigo | borrower.address.city.code | Código IBGE | Código IBGE da cidade (7 dígitos) |
Endereco_Cidade_Nome | borrower.address.city.name | Texto livre | Nome da cidade |
Endereco_Estado | borrower.address.state | UF | Sigla do estado (ex: SP, RJ, MG) |
Campos Opcionais (Planilha Básica)
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
NCM | ncmCode | Código NCM | Código NCM (Nomenclatura Comum do Mercosul) (máx. 8 caracteres). Usado para identificação de produtos/mercadorias. |
Email | borrower.email | Email(s) | Email do tomador. Para múltiplos, separar com vírgula |
Endereco_Complemento | borrower.address.additionalInformation | Texto livre | Complemento do endereço (sala, andar, etc.) |
Data_Competencia | accrualOn | YYYY-MM-DD | Data de competência para notas retroativas |
Data_Emissao | issuedOn | YYYY-MM-DD | Data de emissão: se não informada, assume-se a data atual. |
Regime_Tributario_Tomador | borrower.taxRegime | Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal | Regime tributário do tomador do serviço |
Tomador_Telefone | borrower.phoneNumber | Texto livre | Telefone do tomador do serviço |
Tomador_Inscricao_Estadual | borrower.stateTaxNumber | Texto livre | Inscrição estadual do tomador do serviço |
Campos IBS/CBS - Reforma Tributária (Planilha Básica)
⚠️ Regra de Obrigatoriedade Condicional: Se qualquer um dos campos
NBS,IBSCBS_Indicador_OperacaoouIBSCBS_Codigo_Classificacaofor preenchido, todos os três devem ser preenchidos. Esses campos são utilizados para operações que seguem o novo modelo tributário brasileiro (Reforma Tributária).Consulte a documentação completa:
- Tabela de CST e Classificação Tributária (IBS/CBS) - Lista completa de códigos CST e cClassTrib
- Tabela de Indicador da Operação - Códigos de operação (indOp)
- Documentação do Layout de Emissão de NFS-e (RTC) - Documentação completa
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
NBS | nbsCode | Código NBS | Código da Nomenclatura Brasileira de Serviços (máx. 9 dígitos). Consulte a tabela de códigos NBS aqui. |
IBSCBS_Indicador_Operacao | ibsCbs.operationIndicator | Código indOp (ex: 020101, 030101, 100301) | Indicador da operação que determina o local de incidência do IBS/CBS. Consulte a tabela de referência |
IBSCBS_Codigo_Classificacao | ibsCbs.classCode | Código cClassTrib (ex: 000001, 200028, 200052) | Código de Classificação Tributária que define o regime e alíquotas aplicáveis. Consulte a tabela de CST/cClassTrib |
5. Planilha avançada
A planilha avançada possui os mesmos campos da planilha básica e mais os campos adicionais listados abaixo.
⚠️ Importante: O nome de cada coluna na planilha deve ser exatamente igual ao descrito na coluna "Campo/Coluna" das tabelas abaixo. Qualquer diferença (espaços, acentos, maiúsculas/minúsculas diferentes) fará com que o sistema não reconheça o campo.
Campos Tributários Básicos
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
CNAE | cnaeCode | Código CNAE | Código CNAE da atividade |
Codigo_Servico_Federal | federalServiceCode | Código LC 116 | Código federal do serviço conforme Lei Complementar 116. Saiba mais sobre códigos de serviço |
NBS | nbsCode | Código NBS | Código da Nomenclatura Brasileira de Serviços. Consulte a tabela de códigos NBS aqui. |
NCM | ncmCode | Código NCM | Código NCM (Nomenclatura Comum do Mercosul) (máx. 8 caracteres) |
Inscricao_Municipal | borrower.municipalTaxNumber | Texto livre | Inscrição municipal do tomador |
Informacoes_Adicionais | additionalInformation | Texto livre | Informações complementares para a nota |
CAEPF_Tomador | borrower.caepf | Numérico | Cadastro de Atividade Econômica da Pessoa Física do tomador (máx. 14 dígitos) |
Tomador_Motivo_Sem_NIF | borrower.noTaxIdReason | OtherNotInformedOriginal, Exempted, NotRequired | Justificativa para ausência de NIF do tomador |
Pagamento_Parcelado_Antecipado | isEarlyInstallmentPayment | true, false | Indica se é pagamento parcelado antecipado |
Tipo_Tributacao | taxationType | None, WithinCity, OutsideCity, Export, Free, Immune, SuspendedCourtDecision, SuspendedAdministrativeProcedure, OutsideCityFree, OutsideCityImmune, OutsideCitySuspended, OutsideCitySuspendedAdministrativeProcedure, ObjectiveImune, ObjectiveOutsideCityImune | Tipo de tributação do serviço |
Aliquota_ISS | issRate | Numérico (%) | Alíquota do ISS em percentual. Enviada à API como fração: 5 vira 0.05 |
Valor_ISS | issTaxAmount | Numérico | Valor do ISS calculado |
CST_PIS_COFINS | cstPisCofins | 00, 01, 02, 03, 04, 05, 06, 07, 08, 09 | Código de Situação Tributária do PIS/COFINS |
Base_Calculo_PIS_COFINS | pisCofinsBaseTax | Numérico | Base de cálculo para PIS e COFINS |
Aliquota_PIS | pisRate | Numérico (%) | Alíquota do PIS. Enviada à API como fração: 5 vira 0.05 |
Valor_PIS | pisAmount | Numérico | Valor do PIS (sem retenção) |
Aliquota_COFINS | cofinsRate | Numérico (%) | Alíquota do COFINS. Enviada à API como fração: 5 vira 0.05 |
Valor_COFINS | cofinsAmount | Numérico | Valor do COFINS (sem retenção) |
Retencao_IR | irAmountWithheld | Numérico | Valor da retenção de IR |
Retencao_PIS | pisAmountWithheld | Numérico | Valor da retenção de PIS |
Retencao_COFINS | cofinsAmountWithheld | Numérico | Valor da retenção de COFINS |
Retencao_CSLL | csllAmountWithheld | Numérico | Valor da retenção de CSLL |
Retencao_INSS | inssAmountWithheld | Numérico | Valor da retenção de INSS |
Retencao_ISS | issAmountWithheld | Numérico | Valor da retenção de ISS |
Aliquota_CSLL | csllRate | Numérico (%) | Alíquota do CSLL. Enviada à API como fração: 5 vira 0.05 |
Aliquota_INSS | inssRate | Numérico (%) | Alíquota do INSS. Enviada à API como fração: 5 vira 0.05 |
Aliquota_IPI | ipiRate | Numérico (%) | Alíquota do IPI. Enviada à API como fração: 5 vira 0.05 |
Valor_IPI | ipiAmount | Numérico | Valor do IPI calculado |
Retencao_OUTROS | othersAmountWithheld | Numérico | Valor de outras retenções |
Valor_Deducoes | deductionsAmount | Numérico | Valor das deduções legais |
Valor_Desconto_Incondicionado | discountUnconditionedAmount | Numérico | Valor do desconto incondicionado |
Valor_Desconto_Condicionado | discountConditionedAmount | Numérico | Valor do desconto condicionado |
Valor_Recebido | paidAmount | Numérico | Valor efetivamente recebido |
Tipo_Tomador | borrower.type | PF, Pessoa Física, PJ, Pessoa Jurídica, NaturalPerson, LegalEntity, Undefined | Tipo do tomador do serviço. Enviado à API como NaturalPerson, LegalEntity ou Undefined |
Estado_Prestacao_Servico | location.state | UF | Estado onde o serviço foi prestado |
Cidade_Prestacao_Servico | location.city.name | Texto livre | Nome da cidade onde o serviço foi prestado |
Codigo_Cidade_Prestacao_Servico | location.city.code | Código IBGE | Código IBGE da cidade de prestação |
ID_Externo | externalId | Texto livre | Identificador externo para integração |
RPS_Serie | rpsSerialNumber | Texto livre | Série do RPS (máx. 5 caracteres). Se não informado, usa o valor do cadastro da empresa |
RPS_Numero | rpsNumber | Numérico | Número do RPS. Se não informado, usa o próximo da sequência automática |
Local de Prestação do Serviço
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Pais_Prestacao_Servico | location.country | Código ISO 3166-1 | País de prestação do serviço (ex: BRA) |
Cep_Prestacao_Servico | location.postalCode | CEP | CEP do local de prestação do serviço |
Logradouro_Prestacao_Servico | location.street | Texto livre | Logradouro do local de prestação |
Numero_Prestacao_Servico | location.number | Texto livre | Número do local de prestação |
Bairro_Prestacao_Servico | location.district | Texto livre | Bairro do local de prestação |
Complemento_Prestacao_Servico | location.AdditionalInformation | Texto livre | Complemento do endereço de prestação |
Atividade/Evento
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Nome_Atividade_Evento | activityEvent.name | Texto livre | Nome da atividade ou evento |
Data_Inicio_Evento | activityEvent.beginOn | YYYY-MM-DD | Data de início do evento |
Data_Fim_Evento | activityEvent.endOn | YYYY-MM-DD | Data de término do evento |
Codigo_Atividade_Evento | activityEvent.code | Texto livre | Código identificador da atividade/evento |
Endereço do Evento
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Evento_Endereco_Pais | activityEvent.address.country | Código ISO 3166-1 | País do evento (ex: BRA) |
Evento_Endereco_Cep | activityEvent.address.postalCode | CEP | CEP do local do evento |
Evento_Endereco_Logradouro | activityEvent.address.street | Texto livre | Logradouro do evento |
Evento_Endereco_Numero | activityEvent.address.number | Texto livre | Número do endereço do evento |
Evento_Endereco_Complemento | activityEvent.address.additionalInformation | Texto livre | Complemento do endereço do evento |
Evento_Endereco_Bairro | activityEvent.address.district | Texto livre | Bairro do evento |
Evento_Endereco_Cidade_Codigo | activityEvent.address.city.code | Código IBGE | Código IBGE da cidade do evento |
Evento_Endereco_Cidade_Nome | activityEvent.address.city.name | Texto livre | Nome da cidade do evento |
Evento_Endereco_Estado | activityEvent.address.state | UF | Estado do evento (ex: SP) |
Imóvel
Campos para serviços relacionados a imóveis (ex: serviços de manutenção, limpeza, administração de imóveis).
Estas colunas também alimentam os dados de imóvel exigidos na apuração do IBS/CBS: não há colunas separadas de imóvel no grupo IBS/CBS.
Para locação de imóvel (município, dados da locação e ajustes da base de cálculo), veja Locação de imóvel.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Imovel_Inscricao_Fiscal | realEstate.propertyFiscalRegistration | Texto livre | Inscrição imobiliária do imóvel (número de cadastro municipal) |
Imovel_CIB | realEstate.cibCode | Texto livre | Código de Identificação de Bens (imóvel) |
Imovel_Endereco_Pais | realEstate.siteAddress.country | Código ISO 3166-1 | País do imóvel (ex: BRA) |
Imovel_Endereco_Cep | realEstate.siteAddress.postalCode | CEP | CEP do imóvel |
Imovel_Endereco_Logradouro | realEstate.siteAddress.street | Texto livre | Logradouro do imóvel |
Imovel_Endereco_Numero | realEstate.siteAddress.number | Texto livre | Número do endereço do imóvel |
Imovel_Endereco_Complemento | realEstate.siteAddress.additionalInformation | Texto livre | Complemento do endereço do imóvel |
Imovel_Endereco_Bairro | realEstate.siteAddress.district | Texto livre | Bairro do imóvel |
Imovel_Endereco_Cidade_Codigo | realEstate.siteAddress.city.code | Código IBGE | Código IBGE da cidade do imóvel |
Imovel_Endereco_Cidade_Nome | realEstate.siteAddress.city.name | Texto livre | Nome da cidade do imóvel |
Imovel_Endereco_Estado | realEstate.siteAddress.state | UF | Estado do imóvel (ex: SP) |
Obra/Construção Civil
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Obra_CNO | construction.workId.value | Texto livre | Cadastro Nacional de Obras. Enviado com construction.workId.scheme = bra.cno. Quando Obra_CNO e Obra_CEI são preenchidos, vale o CNO |
Obra_CEI | construction.workId.value | Texto livre | Cadastro Específico do INSS. Enviado com construction.workId.scheme = bra.cei |
Obra_CIB | construction.cibCode | Texto livre | Código de Identificação de Bens |
Obra_Inscricao_Fiscal | construction.propertyFiscalRegistration | Texto livre | Inscrição imobiliária fiscal da obra |
Obra_Endereco_Pais | construction.siteAddress.country | Código ISO 3166-1 | País da obra (ex: BRA) |
Obra_Endereco_Cep | construction.siteAddress.postalCode | CEP | CEP da obra |
Obra_Endereco_Logradouro | construction.siteAddress.street | Texto livre | Logradouro da obra |
Obra_Endereco_Numero | construction.siteAddress.number | Texto livre | Número do endereço da obra |
Obra_Endereco_Complemento | construction.siteAddress.additionalInformation | Texto livre | Complemento do endereço da obra |
Obra_Endereco_Bairro | construction.siteAddress.district | Texto livre | Bairro da obra |
Obra_Endereco_Cidade_Codigo | construction.siteAddress.city.code | Código IBGE | Código IBGE da cidade da obra |
Obra_Endereco_Cidade_Nome | construction.siteAddress.city.name | Texto livre | Nome da cidade da obra |
Obra_Endereco_Estado | construction.siteAddress.state | UF | Estado da obra (ex: SP) |
Comércio Exterior
Consulte a [Tabela de Referência de Comércio Exterior](/docs/documentacao/reforma-tributaria/conceitos-funcionais/tabelas-de-referencia/tabela-referencia-comercio-exterior /) para todos os códigos, vínculos, modos de prestação, moedas e mecanismos de fomento utilizados nos campos abaixo.
Fatura e contrato de câmbio (leiaute 1.02):
Comercio_Exterior_Numero_Fatura,Comercio_Exterior_Valor_FaturaeComercio_Exterior_Numero_Contrato_Cambiosó chegam ao XML no leiaute 1.02 da NFS-e nacional. Veja Grupos da NT 009. No leiaute 1.01, a API ignora estas colunas, e a nota é emitida sem elas.Regras de preenchimento:
- Célula vazia: o campo não vai para a API.
- Quando
Comercio_Exterior_Numero_Fatura,Comercio_Exterior_Valor_FaturaouComercio_Exterior_Numero_Contrato_Cambioé preenchida,Comercio_Exterior_Modo_Prestacao,Comercio_Exterior_Vinculo,Comercio_Exterior_MoedaeComercio_Exterior_Valor_Servico_Moedapassam a ser obrigatórias. Cada coluna obrigatória vazia recebe um erro e bloqueia a linha.Comercio_Exterior_Numero_FaturaeComercio_Exterior_Numero_Contrato_Cambioaceitam até 20 caracteres.- Formate as células
Comercio_Exterior_Numero_FaturaeComercio_Exterior_Numero_Contrato_Cambiocomo Texto antes de digitar o número. O editor de planilha guarda só 15 dígitos de um número. Um número com mais de 15 dígitos digitado como número perde os dígitos finais e bloqueia a linha. Nesse caso, formate a célula como Texto e digite o número de novo.Comercio_Exterior_Valor_Faturaaceita somente número maior ou igual a 0,01. Zero, valor negativo e texto bloqueiam a linha.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Comercio_Exterior_Modo_Prestacao | foreignTrade.serviceMode | Unknown, CrossBorder, ConsumptionInBrazil, TemporaryPersonnel, ConsumptionAbroad | Modo de prestação do serviço internacional. Veja a tabela de referência para todos os códigos. Obrigatório quando a fatura ou o contrato de câmbio é preenchido. |
Comercio_Exterior_Vinculo | foreignTrade.relationShip | NoLink, Controlled, Controller, Affiliate, HeadOffice, Branch, OtherLink | Vínculo entre prestador e tomador. Veja a tabela de referência para todos os códigos. Obrigatório quando a fatura ou o contrato de câmbio é preenchido. |
Comercio_Exterior_Moeda | foreignTrade.currency | Código Siscomex/BACEN | Moeda da operação (ex: 220, 756, etc). Veja a tabela oficial de moedas do Banco Central do Brasil para todos os códigos. Obrigatório quando a fatura ou o contrato de câmbio é preenchido. |
Comercio_Exterior_Valor_Servico_Moeda | foreignTrade.serviceAmountInCurrency | Numérico | Valor do serviço na moeda estrangeira. Obrigatório quando a fatura ou o contrato de câmbio é preenchido. |
Comercio_Exterior_Fomento_Prestador | foreignTrade.supportMechanismProvider | Unknown, None, Acc, Ace, BndesEximPostShipServices, BndesEximPreShipServices, Fge, ProexEqualization, ProexFinancing | Mecanismo de fomento do prestador. Veja a tabela de referência para todos os códigos. |
Comercio_Exterior_Fomento_Tomador | foreignTrade.supportMechanismReceiver | 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 | Mecanismo de fomento do tomador. Veja a tabela de referência para todos os códigos. |
Comercio_Exterior_Movimentacao_Temporaria_Bens | foreignTrade.temporaryGoods | Unknown, No, LinkedImportDeclaration, LinkedExportDeclaration | Movimentação temporária de bens. Veja a tabela de referência para todos os códigos. |
Comercio_Exterior_Declaracao_Importacao | foreignTrade.importDeclaration | Texto livre | Número da declaração de importação |
Comercio_Exterior_Registro_Exportacao | foreignTrade.exportRegistration | Texto livre | Número do registro de exportação |
Comercio_Exterior_Envio_MDIC | foreignTrade.mdicDelivery | true, false | Indicador de envio ao MDIC |
Comercio_Exterior_Numero_Fatura | foreignTrade.invoiceNumber | Texto livre (máx. 20) | Número da fatura (nFatura). Formate a célula como Texto para manter os zeros à esquerda. Um número com mais de 15 dígitos digitado como número bloqueia a linha. Leiaute 1.02. |
Comercio_Exterior_Valor_Fatura | foreignTrade.invoiceAmount | Numérico (mínimo 0,01) | Valor da fatura (vFatura). Leiaute 1.02. |
Comercio_Exterior_Numero_Contrato_Cambio | foreignTrade.exchangeContractNumber | Texto livre (máx. 20) | Número do contrato de câmbio (nContCambio). Formate a célula como Texto para manter os zeros à esquerda. Um número com mais de 15 dígitos digitado como número bloqueia a linha. Leiaute 1.02. |
Intermediário
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Intermediario_Tipo | intermediary.type | Undefined, NaturalPerson, LegalEntity | Tipo do intermediário (Pessoa Física ou Jurídica) |
Intermediario_Nome | intermediary.name | Texto livre | Nome ou Razão Social do intermediário |
Intermediario_CPF_CNPJ | intermediary.federalTaxNumber | CPF ou CNPJ | CPF ou CNPJ do intermediário |
Intermediario_Inscricao_Municipal | intermediary.municipalTaxNumber | Texto livre | Inscrição municipal do intermediário |
Intermediario_Inscricao_Estadual | intermediary.stateTaxNumber | Texto livre | Inscrição estadual do intermediário |
Intermediario_Regime_Tributario | intermediary.taxRegime | Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal | Regime tributário do intermediário |
Intermediario_CAEPF | intermediary.caepf | Numérico | Cadastro de Atividade Econômica da Pessoa Física do intermediário (máx. 14 dígitos) |
Intermediario_Motivo_Sem_NIF | intermediary.noTaxIdReason | OtherNotInformedOriginal, Exempted, NotRequired | Justificativa para ausência de NIF do intermediário |
Intermediario_Telefone | intermediary.phoneNumber | Texto livre | Telefone do intermediário |
Intermediario_Email | intermediary.email | Email do intermediário | |
Intermediario_Endereco_Pais | intermediary.address.country | Código ISO 3166-1 | País do intermediário |
Intermediario_Endereco_Cep | intermediary.address.postalCode | CEP | CEP do intermediário |
Intermediario_Endereco_Logradouro | intermediary.address.street | Texto livre | Logradouro do intermediário |
Intermediario_Endereco_Numero | intermediary.address.number | Texto livre | Número do endereço do intermediário |
Intermediario_Endereco_Complemento | intermediary.address.additionalInformation | Texto livre | Complemento do endereço do intermediário |
Intermediario_Endereco_Bairro | intermediary.address.district | Texto livre | Bairro do intermediário |
Intermediario_Endereco_Cidade_Codigo | intermediary.address.city.code | Código IBGE | Código IBGE da cidade do intermediário |
Intermediario_Endereco_Cidade_Nome | intermediary.address.city.name | Texto livre | Nome da cidade do intermediário |
Intermediario_Endereco_Estado | intermediary.address.state | UF | Estado do intermediário |
Destinatário (quando diferente do tomador)
Regras de preenchimento:
- O sistema envia o destinatário (
recipient) só quandoDestinatario_NomeouDestinatario_CPF_CNPJestá preenchido. As demais colunasDestinatario_*sozinhas não são enviadas.- Com o destinatário enviado e
IBSCBS_Indicador_Destinovazio, o sistema enviaDifferentFromBuyerquando a nota já tem o grupo IBS/CBS, preenchido por outras colunas do grupo (inclusive as de reembolso a terceiros). Sem essas colunas, a nota sai sem o grupo IBS/CBS, como antes.- Com o destinatário enviado,
IBSCBS_Indicador_Destino = SameAsBuyerbloqueia a linha, porque o destinatário seria descartado. UseDifferentFromBuyerou deixe a coluna vazia.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Destinatario_Nome | recipient.name | Texto livre | Nome ou Razão Social do destinatário |
Destinatario_CPF_CNPJ | recipient.federalTaxNumber | CPF ou CNPJ | CPF ou CNPJ do destinatário |
Destinatario_Email | recipient.email | Email do destinatário | |
Destinatario_Tipo | recipient.type | PF, Pessoa Física, PJ, Pessoa Jurídica, NaturalPerson, LegalEntity, Undefined | Tipo do destinatário (Pessoa Física ou Jurídica). Aceita os mesmos valores de Tipo_Tomador e é enviado à API como NaturalPerson, LegalEntity ou Undefined |
Destinatario_Inscricao_Municipal | recipient.municipalTaxNumber | Texto livre | Inscrição municipal do destinatário |
Destinatario_Inscricao_Estadual | recipient.stateTaxNumber | Texto livre | Inscrição estadual do destinatário |
Destinatario_Regime_Tributario | recipient.taxRegime | Isento, MicroempreendedorIndividual, SimplesNacional, LucroPresumido, LucroReal | Regime tributário do destinatário |
Destinatario_CAEPF | recipient.caepf | Numérico | Cadastro de Atividade Econômica da Pessoa Física do destinatário (máx. 14 dígitos) |
Destinatario_Motivo_Sem_NIF | recipient.noTaxIdReason | OtherNotInformedOriginal, Exempted, NotRequired | Justificativa para ausência de NIF do destinatário |
Destinatario_Telefone | recipient.phoneNumber | Texto livre | Telefone do destinatário |
Destinatario_Endereco_Pais | recipient.address.country | Código ISO 3166-1 | País do destinatário |
Destinatario_Endereco_Cep | recipient.address.postalCode | CEP | CEP do destinatário |
Destinatario_Endereco_Logradouro | recipient.address.street | Texto livre | Logradouro do destinatário |
Destinatario_Endereco_Numero | recipient.address.number | Texto livre | Número do endereço do destinatário |
Destinatario_Endereco_Complemento | recipient.address.additionalInformation | Texto livre | Complemento do endereço do destinatário |
Destinatario_Endereco_Bairro | recipient.address.district | Texto livre | Bairro do destinatário |
Destinatario_Endereco_Cidade_Codigo | recipient.address.city.code | Código IBGE | Código IBGE da cidade do destinatário |
Destinatario_Endereco_Cidade_Nome | recipient.address.city.name | Texto livre | Nome da cidade do destinatário |
Destinatario_Endereco_Estado | recipient.address.state | UF | Estado do destinatário |
Locação de Bens
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Locacao_Categoria | lease.category | Lease, Sublease, Leasehold, RightOfWay, UsePermission | Categoria da locação (Locação, Sublocação, Arrendamento, Direito de Passagem, Permissão de Uso) |
Locacao_Objeto | lease.objectType | Railway, Road, Poles, Cables, Pipelines, Conduits | Objeto da locação (Ferrovia, Rodovia, Postes, Cabos, Dutos, Condutos) |
Locacao_Extensao | lease.totalLength | Numérico | Extensão em metros |
Benefício Municipal
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Beneficio_ID | benefit.id | Texto livre | Identificador do benefício fiscal municipal |
Beneficio_Valor | benefit.amount | Numérico | Valor do benefício |
Suspensão de Exigibilidade
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Suspensao_Motivo | suspension.reason | Judicial, Administrative | Motivo da suspensão da exigibilidade (Decisão Judicial ou Procedimento Administrativo) |
Suspensao_Numero_Processo | suspension.processNumber | Texto livre | Número do processo judicial ou administrativo |
Tipo de Imunidade
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Tipo_Imunidade | immunityType | Unspecified, PublicEntitiesMutual, Temples, PartiesUnionsEducationSocialNonprofit, BooksPressPaper, BrazilianMusicPhonograms | Tipo de imunidade tributária (CF88, Art 150, VI) |
Tipo de Retenção
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Tipo_Retencao | retentionType | NotWithheld, WithheldByBuyer, WithheldByIntermediary | Tipo de retenção do ISSQN (Não Retido, Retido pelo Tomador, Retido pelo Intermediário) |
Tributos Aproximados (Lei 12.741/2012)
Os campos de tributos aproximados atendem à Lei 12.741/2012 ("Lei De Olho no Imposto"). Você pode usar a estrutura simplificada (totais consolidados) ou a estrutura detalhada (por esfera governamental).
Estrutura Simplificada
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Tributos_Aproximados_Fonte | approximateTax.source | Texto livre | Fonte da informação (ex: IBPT) |
Tributos_Aproximados_Versao | approximateTax.version | Texto livre | Versão da tabela (ex: 24.1.A) |
Tributos_Aproximados_Percentual_Total | approximateTax.totalRate | Numérico (%) | Percentual total da carga tributária |
Tributos_Aproximados_Valor_Total | approximateTax.totalAmount | Numérico | Valor total aproximado dos tributos |
Estrutura Detalhada
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Tributos_Aproximados_Federal_Percentual | approximateTotals.federal.rate | Numérico (%) | Percentual de tributos federais |
Tributos_Aproximados_Federal_Valor | approximateTotals.federal.amount | Numérico | Valor de tributos federais |
Tributos_Aproximados_Estadual_Percentual | approximateTotals.state.rate | Numérico (%) | Percentual de tributos estaduais |
Tributos_Aproximados_Estadual_Valor | approximateTotals.state.amount | Numérico | Valor de tributos estaduais |
Tributos_Aproximados_Municipal_Percentual | approximateTotals.municipal.rate | Numérico (%) | Percentual de tributos municipais |
Tributos_Aproximados_Municipal_Valor | approximateTotals.municipal.amount | Numérico | Valor de tributos municipais |
Tributos_Aproximados_Detalhado_Percentual_Total | approximateTotals.rate | Numérico (%) | Percentual total agregado dos tributos aproximados detalhados |
Tributos_Aproximados_Detalhado_Valor_Total | approximateTotals.amount | Numérico | Valor total agregado dos tributos aproximados detalhados |
Substituição de NFS-e
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Substituicao_Chave_NFSe | referenceSubstitution.id | Texto livre | Chave da NFS-e a ser substituída (44 dígitos) |
Substituicao_Motivo | referenceSubstitution.reason | SnOut, SnIn, ImmunityAddRetro, ImmunityRemoveRetro, RejectionBuyerOrIntermediary, Other | Motivo da substituição |
Substituicao_Motivo_Texto | referenceSubstitution.reasonText | Texto livre (15 a 255 caracteres) | Descrição do motivo da substituição (xMotivo). Recomendada quando o motivo é Other. Preencha somente com Substituicao_Chave_NFSe |
Informações Adicionais Estruturadas
Além do campo
Informacoes_Adicionais(texto livre), você pode estruturar informações específicas:
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Info_Adicional_ART_RRT | additionalInformationGroup.responsibilityDocumentIdentifier | Texto livre | Documento de responsabilidade técnica (ART/RRT) |
Info_Adicional_Documento_Referencia | additionalInformationGroup.referencedDocument | Texto livre | Documento referenciado |
Info_Adicional_Pedido | additionalInformationGroup.order | Texto livre | Número do pedido/ordem de compra |
Info_Adicional_Itens_Pedido | additionalInformationGroup.items[].item | Texto livre | Itens do pedido separados por vírgula ou ponto e vírgula (ex: Item A, Item B ou Item A; Item B; Item C) |
Info_Adicional_Outras_Informacoes | additionalInformationGroup.otherInformation | Texto livre | Outras informações complementares |
Documento de Dedução (grupo deduction.documents)
Use este grupo para detalhar um documento fiscal que justifique uma dedução/redução da base de cálculo do ISSQN, alinhado ao padrão da NFS-e Nacional. É a forma mais completa e recomendada quando você possui os dados do documento que embasa a dedução, e o sistema de emissão prioriza estes campos em relação ao
Valor_Deducoes.⚠️ Um documento por nota: como a planilha prevê apenas uma nota por linha, é permitido preencher apenas um documento de dedução por NFS-e. Para enviar múltiplos documentos por nota, utilize a API REST.
Regras de preenchimento:
- Pelo menos um dos campos identificadores (
Deducao_Documento_Chave_NFSe_Nacional,Deducao_Documento_Chave_NFe, o blocoDeducao_Documento_NFSe_Municipal_*,Deducao_Documento_Numero_Documento_FiscalouDeducao_Documento_Numero_Documento_Nao_Fiscal) é obrigatório quando o grupo é utilizado. Se mais de um identificador for enviado, o backend aplica a precedência nessa ordem.- Quando qualquer campo do grupo é preenchido, os campos
Deducao_Documento_Tipo,Deducao_Documento_Data_Emissao,Deducao_Documento_Valor_DedutiveleDeducao_Documento_Valor_Utilizadopassam a ser obrigatórios.- Quando
Deducao_Documento_Tipo = Other, o campoDeducao_Documento_Outra_Descricaopassa a ser obrigatório.- Quando qualquer um dos campos do bloco
Deducao_Documento_NFSe_Municipal_*é preenchido, os três (Codigo_Cidade,Numero,Codigo_Verificacao) devem ser preenchidos.Deducao_Documento_Valor_Utilizadodeve ser menor ou igual aDeducao_Documento_Valor_Dedutivel.
Identificadores do documento (ao menos um é obrigatório)
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Deducao_Documento_Chave_NFSe_Nacional | deduction.documents[].nfseKey | 50 dígitos | Chave de acesso da NFS-e nacional (chNFSe). |
Deducao_Documento_Chave_NFe | deduction.documents[].nfeKey | 44 dígitos | Chave de acesso da NF-e de produto (chNFe). |
Deducao_Documento_NFSe_Municipal_Codigo_Cidade | deduction.documents[].municipalNfse.cityCode | Código IBGE | Código IBGE do município emissor (cMunNFSeMun). |
Deducao_Documento_NFSe_Municipal_Numero | deduction.documents[].municipalNfse.number | Texto (máx. 15) | Número da NFS-e municipal (nNFSeMun). |
Deducao_Documento_NFSe_Municipal_Codigo_Verificacao | deduction.documents[].municipalNfse.verificationCode | Texto (máx. 9) | Código de verificação da NFS-e municipal (cVerifNFSeMun). |
Deducao_Documento_Numero_Documento_Fiscal | deduction.documents[].fiscalDocumentNumber | Texto (máx. 255) | Identificador de outro documento fiscal não eletrônico (nDocFisc). |
Deducao_Documento_Numero_Documento_Nao_Fiscal | deduction.documents[].nonFiscalDocumentNumber | Texto (máx. 255) | Identificador de documento não fiscal, ex: nota de débito interna (nDoc). |
Dados obrigatórios do documento
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Deducao_Documento_Tipo | deduction.documents[].deductionType | FoodAndBeverages, Materials, ConsortiumPassThrough, HealthPlanPassThrough, Services, Subcontracting, Other | Tipo da dedução/redução (tpDedRed). Valores: Alimentação/bebidas, Materiais, Repasse consorciado, Repasse plano de saúde, Serviços, Subempreitada de mão de obra, Outras. |
Deducao_Documento_Outra_Descricao | deduction.documents[].otherDeductionDescription | Texto livre (máx. 150) | Descrição livre da dedução (xDescOutDed). Obrigatório quando Deducao_Documento_Tipo = Other. |
Deducao_Documento_Data_Emissao | deduction.documents[].issueDate | YYYY-MM-DD | Data de emissão do documento de origem (dtEmiDoc). |
Deducao_Documento_Valor_Dedutivel | deduction.documents[].deductibleTotal | Numérico | Valor total dedutível/redutível no documento de origem (vDedutivelRedutivel). |
Deducao_Documento_Valor_Utilizado | deduction.documents[].usedAmount | Numérico | Valor efetivamente utilizado como dedução nesta NFS-e (vDeducaoReducao). Deve ser ≤ Deducao_Documento_Valor_Dedutivel. |
Fornecedor do documento (opcional)
Dados do emitente do documento que embasa a dedução (
fornec). Baseado empartyDefinition.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Deducao_Documento_Fornecedor_Tipo | deduction.documents[].supplier.type | Undefined, NaturalPerson, LegalEntity | Tipo do fornecedor (Pessoa Física ou Jurídica). |
Deducao_Documento_Fornecedor_Nome | deduction.documents[].supplier.name | Texto livre (máx. 115) | Nome ou Razão Social do fornecedor. |
Deducao_Documento_Fornecedor_CPF_CNPJ | deduction.documents[].supplier.federalTaxNumber | CPF ou CNPJ | CPF ou CNPJ do fornecedor. Pode ser com ou sem formatação. |
Deducao_Documento_Fornecedor_CAEPF | deduction.documents[].supplier.caepf | Numérico | Cadastro de Atividade Econômica da Pessoa Física do fornecedor (máx. 14 dígitos). |
Deducao_Documento_Fornecedor_Motivo_Sem_NIF | deduction.documents[].supplier.noTaxIdReason | OtherNotInformedOriginal, Exempted, NotRequired | Justificativa para ausência de NIF do fornecedor. |
Deducao_Documento_Fornecedor_Telefone | deduction.documents[].supplier.phoneNumber | Texto livre | Telefone do fornecedor. |
Deducao_Documento_Fornecedor_Email | deduction.documents[].supplier.email | Email do fornecedor. | |
Deducao_Documento_Fornecedor_Endereco_Pais | deduction.documents[].supplier.address.country | Código ISO 3166-1 | País do fornecedor (ex: BRA). |
Deducao_Documento_Fornecedor_Endereco_Cep | deduction.documents[].supplier.address.postalCode | CEP | CEP do endereço do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Logradouro | deduction.documents[].supplier.address.street | Texto livre | Logradouro do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Numero | deduction.documents[].supplier.address.number | Texto livre | Número do endereço do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Complemento | deduction.documents[].supplier.address.additionalInformation | Texto livre | Complemento do endereço do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Bairro | deduction.documents[].supplier.address.district | Texto livre | Bairro do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Cidade_Codigo | deduction.documents[].supplier.address.city.code | Código IBGE | Código IBGE da cidade do fornecedor (7 dígitos). |
Deducao_Documento_Fornecedor_Endereco_Cidade_Nome | deduction.documents[].supplier.address.city.name | Texto livre | Nome da cidade do fornecedor. |
Deducao_Documento_Fornecedor_Endereco_Estado | deduction.documents[].supplier.address.state | UF | Sigla do estado do fornecedor (ex: SP). |
Documento de Reembolso a Terceiros (grupo ibsCbs.thirdPartyReimbursements.documents)
Use este grupo para detalhar um documento que justifique um valor de reembolso ou repasse a terceiros no contexto da Reforma Tributária (IBS/CBS). Exemplos típicos: corretagem imobiliária com repasse, agência de viagens repassando ao fornecedor, agência de publicidade reembolsando produção externa ou mídia.
⚠️ Um documento por nota: como a planilha prevê apenas uma nota por linha, é permitido preencher apenas um documento de reembolso a terceiros por NFS-e. Para enviar múltiplos documentos por nota, utilize a API REST.
Regras de preenchimento:
- Preencha exatamente um destes caminhos de identificação quando o grupo é utilizado:
Reembolso_Terceiros_Documento_Chave_NFSe_Nacional,Reembolso_Terceiros_Documento_Chave_NFe,Reembolso_Terceiros_Documento_Chave_CTe, o blocoReembolso_Terceiros_Documento_Outro_DFe_Nacional_*, o blocoReembolso_Terceiros_Documento_Outro_Doc_Fiscal_*ou o blocoReembolso_Terceiros_Documento_Outro_Doc_Nao_Fiscal_*. Linha com mais de um caminho preenchido fica bloqueada para envio.- As três colunas de chave são enviadas em
otherNationalDfe, o mesmo campo da API do blocoOutro_DFe_Nacional_*, comdfeType1(NFS-e),2(NF-e) ou3(CT-e) preenchido automaticamente.- Quando qualquer campo do grupo é preenchido, os campos
Reembolso_Terceiros_Documento_Data_Emissao,Reembolso_Terceiros_Documento_Data_Competencia,Reembolso_Terceiros_Documento_TipoeReembolso_Terceiros_Documento_Valorpassam a ser obrigatórios.- Quando o bloco
Reembolso_Terceiros_Documento_Outro_DFe_Nacional_*é utilizado, o campoOutro_DFe_Nacional_Tipo_Textopassa a ser obrigatório (Outro_DFe_Nacional_Chaveé opcional).- Quando o bloco
Reembolso_Terceiros_Documento_Outro_Doc_Fiscal_*é utilizado, os camposOutro_Doc_Fiscal_Codigo_Cidade_EmissoreOutro_Doc_Fiscal_Numerosão obrigatórios.- Quando o bloco
Reembolso_Terceiros_Documento_Outro_Doc_Nao_Fiscal_*é utilizado, os dois campos (NumeroeDescricao) são obrigatórios.Reembolso_Terceiros_Documento_Tipo_Descricaoé opcional. Preencha somente comReembolso_Terceiros_Documento_Tipo = OtherReimbursement. Com outro tipo, a linha fica bloqueada para envio.
Identificador do documento (anyOf: escolha exatamente um caminho)
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Reembolso_Terceiros_Documento_Chave_NFSe_Nacional | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeKey | Texto (máx. 50) | Chave de acesso da NFS-e Nacional. Enviada com dfeType = 1 e dfeTypeText = NFS-e, preenchidos automaticamente. |
Reembolso_Terceiros_Documento_Chave_NFe | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeKey | 44 dígitos | Chave de acesso da NF-e. Enviada com dfeType = 2 e dfeTypeText = NF-e, preenchidos automaticamente. |
Reembolso_Terceiros_Documento_Chave_CTe | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeKey | 44 dígitos | Chave de acesso do CT-e. Enviada com dfeType = 3 e dfeTypeText = CT-e, preenchidos automaticamente. |
Reembolso_Terceiros_Documento_Outro_DFe_Nacional_Chave | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeKey | Texto livre | Chave de outro DF-e nacional (chDFE). Obrigatório quando o bloco Outro_DFe_Nacional_* é utilizado. |
Reembolso_Terceiros_Documento_Outro_DFe_Nacional_Tipo_Texto | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeTypeText | Texto livre | Descrição textual do tipo de DF-e (xTpDFE), ex: NFS-e, NF-e, CT-e. Obrigatório quando o bloco Outro_DFe_Nacional_* é utilizado. |
Reembolso_Terceiros_Documento_Outro_DFe_Nacional_Tipo | ibsCbs.thirdPartyReimbursements.documents[].otherNationalDfe.dfeType | Texto (1 caractere) | Código numérico do tipo de DF-e (tipoChaveDFE). Validação fraca no backend, sem enum oficial. |
Reembolso_Terceiros_Documento_Outro_Doc_Fiscal_Codigo_Cidade_Emissor | ibsCbs.thirdPartyReimbursements.documents[].otherFiscalDoc.issuerCityCode | Código IBGE | Código IBGE do município emissor do documento fiscal (cMunEmiDocFisc). Obrigatório quando o bloco Outro_Doc_Fiscal_* é utilizado. |
Reembolso_Terceiros_Documento_Outro_Doc_Fiscal_Numero | ibsCbs.thirdPartyReimbursements.documents[].otherFiscalDoc.fiscalDocNumber | Texto livre | Número do documento fiscal (nDocFisc). Obrigatório quando o bloco Outro_Doc_Fiscal_* é utilizado. |
Reembolso_Terceiros_Documento_Outro_Doc_Fiscal_Descricao | ibsCbs.thirdPartyReimbursements.documents[].otherFiscalDoc.fiscalDocDescription | Texto livre | Descrição complementar do documento fiscal (xDocFisc). |
Reembolso_Terceiros_Documento_Outro_Doc_Nao_Fiscal_Numero | ibsCbs.thirdPartyReimbursements.documents[].otherDoc.docNumber | Texto livre (máx. 255) | Número do documento não fiscal (nDoc). Obrigatório quando o bloco Outro_Doc_Nao_Fiscal_* é utilizado. |
Reembolso_Terceiros_Documento_Outro_Doc_Nao_Fiscal_Descricao | ibsCbs.thirdPartyReimbursements.documents[].otherDoc.docDescription | Texto livre (máx. 255) | Descrição do documento não fiscal (xDoc). Obrigatório quando o bloco Outro_Doc_Nao_Fiscal_* é utilizado. |
Dados obrigatórios do documento
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Reembolso_Terceiros_Documento_Data_Emissao | ibsCbs.thirdPartyReimbursements.documents[].issueDate | YYYY-MM-DD | Data de emissão do documento que originou o reembolso/repasse (dtEmiDoc). |
Reembolso_Terceiros_Documento_Data_Competencia | ibsCbs.thirdPartyReimbursements.documents[].accrualOn | YYYY-MM-DD | Data de competência do reembolso/repasse (dtCompDoc). |
Reembolso_Terceiros_Documento_Tipo | ibsCbs.thirdPartyReimbursements.documents[].reimbursementType | RealEstateBrokerPassThrough, TravelAgencySupplierPassThrough, AdAgencyExternalProductionReimbursement, AdAgencyMediaReimbursement, OtherReimbursement | Tipo do reembolso/repasse (tpReemb). Valores: Repasse de corretagem imobiliária, Repasse de fornecedor de agência de viagens, Reembolso de produção externa de agência de publicidade, Reembolso de mídia de agência de publicidade, Outro reembolso. |
Reembolso_Terceiros_Documento_Tipo_Descricao | ibsCbs.thirdPartyReimbursements.documents[].reimbursementTypeText | Texto livre (máx. 150) | Descrição do tipo de reembolso. Opcional. Preencha somente com o tipo OtherReimbursement. |
Reembolso_Terceiros_Documento_Valor | ibsCbs.thirdPartyReimbursements.documents[].amount | Numérico | Valor do reembolso/repasse a terceiros (vReemb). |
Fornecedor do documento (opcional)
Dados do fornecedor (terceiro) que recebeu o repasse/reembolso (
fornec). Baseado empartyDefinition.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Reembolso_Terceiros_Documento_Fornecedor_Tipo | ibsCbs.thirdPartyReimbursements.documents[].supplier.type | Undefined, NaturalPerson, LegalEntity | Tipo do fornecedor (Pessoa Física ou Jurídica). |
Reembolso_Terceiros_Documento_Fornecedor_Nome | ibsCbs.thirdPartyReimbursements.documents[].supplier.name | Texto livre (máx. 115) | Nome ou Razão Social do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_CPF_CNPJ | ibsCbs.thirdPartyReimbursements.documents[].supplier.federalTaxNumber | CPF ou CNPJ | CPF ou CNPJ do fornecedor. Pode ser com ou sem formatação. |
Reembolso_Terceiros_Documento_Fornecedor_Motivo_Sem_NIF | ibsCbs.thirdPartyReimbursements.documents[].supplier.noTaxIdReason | OtherNotInformedOriginal, Exempted, NotRequired | Justificativa para ausência de NIF do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Pais | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.country | Código ISO 3166-1 | País do fornecedor (ex: BRA). |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Cep | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.postalCode | CEP | CEP do endereço do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Logradouro | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.street | Texto livre | Logradouro do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Numero | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.number | Texto livre | Número do endereço do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Complemento | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.additionalInformation | Texto livre | Complemento do endereço do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Bairro | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.district | Texto livre | Bairro do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Cidade_Codigo | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.city.code | Código IBGE | Código IBGE da cidade do fornecedor (7 dígitos). |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Cidade_Nome | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.city.name | Texto livre | Nome da cidade do fornecedor. |
Reembolso_Terceiros_Documento_Fornecedor_Endereco_Estado | ibsCbs.thirdPartyReimbursements.documents[].supplier.address.state | UF | Sigla do estado do fornecedor (ex: SP). |
Detalhes de Valores do Serviço
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Valor_Inicial_Cobrado | serviceAmountDetails.initialChargedAmount | Numérico | Valor inicial cobrado pelo serviço (antes de tributos, multa e juros) |
Valor_Final_Cobrado | serviceAmountDetails.finalChargedAmount | Numérico | Valor final cobrado pelo serviço (incluindo todos os tributos) |
Valor_Multa | serviceAmountDetails.fineAmount | Numérico | Valor de multa aplicada |
Valor_Juros | serviceAmountDetails.interestAmount | Numérico | Valor de juros aplicados |
IBS/CBS (Reforma Tributária)
Nota sobre a Reforma Tributária: Os campos de IBS/CBS são utilizados para operações que seguem o novo modelo tributário brasileiro (Reforma Tributária). Esses campos são opcionais e devem ser preenchidos apenas quando aplicável à operação.
⚠️ Regra de Obrigatoriedade Condicional: Se qualquer um dos campos
IBSCBS_Indicador_OperacaoouIBSCBS_Codigo_Classificacaofor preenchido, ambos se tornam obrigatórios.Saiba mais sobre a Reforma Tributária:
- Documentação do Layout de Emissão de NFS-e (RTC) - Documentação funcional completa
- Mudanças no Layout de Integração da NFS-e (v4) - Mudanças entre versões
- Tabela de CST e Classificação Tributária (IBS/CBS) - Lista completa de códigos CST e cClassTrib
- Tabela de Indicador da Operação - Códigos de operação (indOp)
Dados Gerais do IBS/CBS
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Indicador_Operacao | ibsCbs.operationIndicator | Código indOp (ex: 020101, 030101, 100301) | Condicionalmente obrigatório. Indicador da operação que determina o local de incidência do IBS/CBS, conforme Art. 11 da LC nº 214/2025. Consulte a tabela completa |
IBSCBS_Codigo_Classificacao | ibsCbs.classCode | Código cClassTrib (ex: 000001, 200028) | Condicionalmente obrigatório. Código de Classificação Tributária que define o regime e alíquotas aplicáveis (ex: tributação integral, alíquota reduzida). Consulte a tabela de CST/cClassTrib |
IBSCBS_Codigo_Situacao | ibsCbs.situationCode | Código CST (ex: 000, 200, 400) | Código da Situação Tributária do IBS/CBS. O CST indica o tratamento tributário da operação (tributação integral, alíquota zero, imunidade, etc.). Consulte a tabela de CST |
IBSCBS_Finalidade | ibsCbs.purpose | regular | Finalidade da operação (atualmente apenas regular é aceito) |
IBSCBS_Indicador_Destino | ibsCbs.destinationIndicator | SameAsBuyer, DifferentFromBuyer | Indicador de destino (mesmo que o tomador ou diferente do tomador) |
IBSCBS_Tipo_Operacao | ibsCbs.operationType | Texto livre | Tipo de operação do IBS/CBS |
IBSCBS_NFSe_Referenciadas | ibsCbs.relatedDocs.items[] | Chaves de NFS-e | Chaves das NFS-e referenciadas, separadas por vírgula, ponto e vírgula ou espaço. Cada chave vira um item da lista. Formate a célula como Texto: a chave tem 50 dígitos e o editor de planilha a converte em notação científica |
IBSCBS_Uso_Pessoal | ibsCbs.personalUse | true, false | Indica se é para uso/consumo pessoal do adquirente |
IBSCBS_Base_Calculo | ibsCbs.basis | Numérico | Base de cálculo do IBS/CBS |
IBSCBS_Valor_Reembolso_Repasse | ibsCbs.reimbursedResuppliedAmount | Numérico | Valor de reembolso ou repasse |
IBSCBS_Doacao | ibsCbs.isDonation | true, false | Indicador de doação |
IBS Estadual
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBS_Estadual_Aliquota | ibsCbs.ibs.state.rate | Numérico (%) | Alíquota do IBS estadual |
IBS_Estadual_Reducao_Aliquota | ibsCbs.ibs.state.rateReduction | Numérico (%) | Percentual de redução da alíquota |
IBS_Estadual_Aliquota_Efetiva | ibsCbs.ibs.state.effectiveRate | Numérico (%) | Alíquota efetiva após reduções |
IBS_Estadual_Valor | ibsCbs.ibs.state.amount | Numérico | Valor calculado do IBS estadual |
IBS_Estadual_Diferimento_Percentual | ibsCbs.ibs.state.deferment.rate | Numérico (%) | Percentual de diferimento |
IBS_Estadual_Diferimento_Valor | ibsCbs.ibs.state.deferment.amount | Numérico | Valor diferido |
IBS_Estadual_Valor_Devolvido | ibsCbs.ibs.state.returnedAmount | Numérico | Valor devolvido (cashback) |
IBS Municipal
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBS_Municipal_Aliquota | ibsCbs.ibs.municipal.rate | Numérico (%) | Alíquota do IBS municipal |
IBS_Municipal_Reducao_Aliquota | ibsCbs.ibs.municipal.rateReduction | Numérico (%) | Percentual de redução da alíquota |
IBS_Municipal_Aliquota_Efetiva | ibsCbs.ibs.municipal.effectiveRate | Numérico (%) | Alíquota efetiva após reduções |
IBS_Municipal_Valor | ibsCbs.ibs.municipal.amount | Numérico | Valor calculado do IBS municipal |
IBS_Municipal_Diferimento_Percentual | ibsCbs.ibs.municipal.deferment.rate | Numérico (%) | Percentual de diferimento |
IBS_Municipal_Diferimento_Valor | ibsCbs.ibs.municipal.deferment.amount | Numérico | Valor diferido |
IBS_Municipal_Valor_Devolvido | ibsCbs.ibs.municipal.returnedAmount | Numérico | Valor devolvido (cashback) |
IBS Total
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBS_Total | ibsCbs.ibs.totalAmount | Numérico | Valor total do IBS (estadual + municipal) |
CBS (Contribuição sobre Bens e Serviços)
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
CBS_Aliquota | ibsCbs.cbs.rate | Numérico (%) | Alíquota da CBS |
CBS_Reducao_Aliquota | ibsCbs.cbs.rateReduction | Numérico (%) | Percentual de redução da alíquota |
CBS_Aliquota_Efetiva | ibsCbs.cbs.effectiveRate | Numérico (%) | Alíquota efetiva após reduções |
CBS_Valor | ibsCbs.cbs.amount | Numérico | Valor calculado da CBS |
CBS_Diferimento_Percentual | ibsCbs.cbs.deferment.rate | Numérico (%) | Percentual de diferimento |
CBS_Diferimento_Valor | ibsCbs.cbs.deferment.amount | Numérico | Valor diferido |
CBS_Valor_Devolvido | ibsCbs.cbs.returnedAmount | Numérico | Valor devolvido (cashback) |
Transferência de Crédito (IBS/CBS)
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Transferencia_Credito_IBS | ibsCbs.creditTransfer.ibsAmount | Numérico | Valor da transferência de crédito de IBS |
IBSCBS_Transferencia_Credito_CBS | ibsCbs.creditTransfer.cbsAmount | Numérico | Valor da transferência de crédito de CBS |
Tributação Regular (IBS/CBS)
Campos para informar dados da tributação pelo regime regular, quando a operação possui tratamento diferenciado no grupo principal de IBS/CBS (ex: imunidade, isenção) mas também precisa informar os valores que seriam devidos na tributação regular.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Trib_Regular_Codigo_Situacao | ibsCbs.regularTaxation.situationCode | Código CST | Código da Situação Tributária da tributação regular |
IBSCBS_Trib_Regular_Codigo_Classificacao | ibsCbs.regularTaxation.classCode | Código cClassTrib | Código de Classificação Tributária da tributação regular |
IBSCBS_Trib_Regular_IBS_Total | ibsCbs.regularTaxation.ibs.totalAmount | Numérico | Valor total do IBS na tributação regular |
IBSCBS_Trib_Regular_IBS_Estadual_Aliquota_Efetiva | ibsCbs.regularTaxation.ibs.state.effectiveRate | Numérico (%) | Alíquota efetiva do IBS estadual na tributação regular |
IBSCBS_Trib_Regular_IBS_Estadual_Valor | ibsCbs.regularTaxation.ibs.state.amount | Numérico | Valor do IBS estadual na tributação regular |
IBSCBS_Trib_Regular_IBS_Municipal_Aliquota_Efetiva | ibsCbs.regularTaxation.ibs.municipal.effectiveRate | Numérico (%) | Alíquota efetiva do IBS municipal na tributação regular |
IBSCBS_Trib_Regular_IBS_Municipal_Valor | ibsCbs.regularTaxation.ibs.municipal.amount | Numérico | Valor do IBS municipal na tributação regular |
IBSCBS_Trib_Regular_CBS_Aliquota_Efetiva | ibsCbs.regularTaxation.cbs.effectiveRate | Numérico (%) | Alíquota efetiva da CBS na tributação regular |
IBSCBS_Trib_Regular_CBS_Valor | ibsCbs.regularTaxation.cbs.amount | Numérico | Valor da CBS na tributação regular |
Crédito Presumido (IBS/CBS)
Campos para informar dados de crédito presumido do IBS e CBS, quando aplicável à operação.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Credito_Presumido_IBS_Codigo | ibsCbs.presumedCredits.ibs.code | Texto livre | Código do crédito presumido de IBS |
IBSCBS_Credito_Presumido_IBS_Aliquota | ibsCbs.presumedCredits.ibs.rate | Numérico (%) | Alíquota do crédito presumido de IBS |
IBSCBS_Credito_Presumido_IBS_Valor | ibsCbs.presumedCredits.ibs.amount | Numérico | Valor do crédito presumido de IBS |
IBSCBS_Credito_Presumido_IBS_Valor_Condicional | ibsCbs.presumedCredits.ibs.conditionalAmount | Numérico | Valor condicional do crédito presumido de IBS |
IBSCBS_Credito_Presumido_CBS_Codigo | ibsCbs.presumedCredits.cbs.code | Texto livre | Código do crédito presumido de CBS |
IBSCBS_Credito_Presumido_CBS_Aliquota | ibsCbs.presumedCredits.cbs.rate | Numérico (%) | Alíquota do crédito presumido de CBS |
IBSCBS_Credito_Presumido_CBS_Valor | ibsCbs.presumedCredits.cbs.amount | Numérico | Valor do crédito presumido de CBS |
IBSCBS_Credito_Presumido_CBS_Valor_Condicional | ibsCbs.presumedCredits.cbs.conditionalAmount | Numérico | Valor condicional do crédito presumido de CBS |
Compra Governamental (IBS/CBS)
Campos para operações de venda de serviços para órgãos governamentais, com tratamento tributário específico.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Compra_Gov_Tipo_Entidade | ibsCbs.governmentPurchase.entityType | Veja os valores aceitos | Tipo de entidade governamental compradora |
IBSCBS_Compra_Gov_IBS_Total | ibsCbs.governmentPurchase.ibs.totalAmount | Numérico | Valor total do IBS na compra governamental |
IBSCBS_Compra_Gov_IBS_Estadual_Aliquota | ibsCbs.governmentPurchase.ibs.state.rate | Numérico (%) | Alíquota do IBS estadual na compra governamental |
IBSCBS_Compra_Gov_IBS_Estadual_Valor | ibsCbs.governmentPurchase.ibs.state.amount | Numérico | Valor do IBS estadual na compra governamental |
IBSCBS_Compra_Gov_IBS_Municipal_Aliquota | ibsCbs.governmentPurchase.ibs.municipal.rate | Numérico (%) | Alíquota do IBS municipal na compra governamental |
IBSCBS_Compra_Gov_IBS_Municipal_Valor | ibsCbs.governmentPurchase.ibs.municipal.amount | Numérico | Valor do IBS municipal na compra governamental |
IBSCBS_Compra_Gov_CBS_Aliquota | ibsCbs.governmentPurchase.cbs.rate | Numérico (%) | Alíquota da CBS na compra governamental |
IBSCBS_Compra_Gov_CBS_Valor | ibsCbs.governmentPurchase.cbs.amount | Numérico | Valor da CBS na compra governamental |
Valores aceitos em IBSCBS_Compra_Gov_Tipo_Entidade
A planilha aceita mais de uma forma de escrever cada entidade, sem diferença entre maiúsculas e minúsculas. O valor enviado à API é sempre o da coluna "Na API".
| Na planilha | Na API | Entidade compradora |
|---|---|---|
federal, Union ou 1 | Union | União |
state, estadual, State ou 2 | State | Estado |
distrito_federal, df, FederalDistrict ou 3 | FederalDistrict | Distrito Federal |
municipal, municipio, Municipality ou 4 | Municipality | Município |
Grupos da NT 009 (leiaute 1.02)
Os grupos desta seção (locação de imóvel, bens móveis, condomínio e NFS-e de ajuste) só chegam ao XML da nota no leiaute 1.02 da NFS-e nacional, definido pela NT 009.
- Hoje, o leiaute 1.02 vale para as notas de homologação.
- Em produção, o leiaute 1.02 passa a valer na Sefin Nacional a partir de 01/12/2026.
No leiaute 1.01:
- A API ignora os dados de locação de imóvel, de bens móveis e de condomínio. A nota é emitida sem eles.
- A API ignora a fatura e o contrato de câmbio da seção Comércio Exterior. A nota é emitida sem eles.
- A API recusa a NFS-e de ajuste antes do envio.
A planilha aceita, por nota, até 5 bens móveis, até 3 ajustes da base de cálculo do imóvel e, no condomínio, até 5 cobranças, até 2 detalhes por cobrança e até 3 descontos. Para enviar mais, use a API REST.
Locação de imóvel
Use nas notas de locação, cessão onerosa ou arrendamento de bem imóvel (código de tributação nacional 99.03). Estas colunas completam a seção Imóvel.
Regras de preenchimento:
- Quando qualquer coluna
Imovel_Locacao_*é preenchida,Imovel_Locacao_Valor_Total_Operacaopassa a ser obrigatória.- A planilha aceita até 3 ajustes da base de cálculo por nota. Troque
{n}pelo número do ajuste, de 1 a 3. Exemplo:Imovel_Ajuste_BC_1_Tipo,Imovel_Ajuste_BC_2_Tipo.- Quando qualquer coluna do ajuste
{n}é preenchida,Imovel_Ajuste_BC_{n}_TipoeImovel_Ajuste_BC_{n}_Valorpassam a ser obrigatórias.- Quando
Imovel_Ajuste_BC_{n}_Tipo = 99,Imovel_Ajuste_BC_{n}_Descricaopassa a ser obrigatória.- Os dados da seção Imóvel (inscrição, CIB e endereço) chegam à nota nos leiautes 1.01 e 1.02, com ou sem ajuste da base de cálculo.
- Os ajustes da base de cálculo (
Imovel_Ajuste_BC_*) só chegam ao XML no leiaute 1.02. No leiaute 1.01, a API ignora os ajustes, e a nota é emitida sem eles.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Imovel_Codigo_Municipio | realEstate.municipalityCode | Código IBGE (7 dígitos) | Código IBGE do município do imóvel (cMun). Formate a célula como Texto. |
Imovel_Locacao_Percentual_Copropriedade | realEstate.leasing.coOwnershipPercentage | Numérico (0 a 100) | Percentual de copropriedade do locador (pCopropriedade). Use 100 quando há um único locador. |
Imovel_Locacao_Valor_Total_Operacao | realEstate.leasing.totalOperationAmount | Numérico | Valor total da operação, sem proporcionalizar (vTotOper). Obrigatório quando qualquer coluna Imovel_Locacao_* é preenchida. |
Imovel_Locacao_Desconto_Incondicionado_Total | realEstate.leasing.unconditionalDiscountTotal | Numérico | Desconto incondicionado total (vDescIncondTot). |
Imovel_Locacao_Desconto_Condicionado_Total | realEstate.leasing.conditionalDiscountTotal | Numérico | Desconto condicionado total (vDescCondTot). |
Imovel_Locacao_Data_Vencimento_Original | realEstate.leasing.originalDueDate | YYYY-MM-DD | Data de vencimento original do aluguel (dVencOrig). |
Imovel_Ajuste_BC_{n}_Tipo | realEstate.propertyUnits[0].baseCalculationAdjustments[].type | 1, 2, 3, 4 ou 99 | Tipo da parcela que não integra a base de cálculo do IBS/CBS na locação (tpAjusteBCLocImoveis). Valores: 1 Tributos inclusos, 2 Emolumento, 3 Condomínio, 4 Redutor social, 99 Outras. |
Imovel_Ajuste_BC_{n}_Descricao | realEstate.propertyUnits[0].baseCalculationAdjustments[].typeDescription | Texto livre (máx. 150) | Descrição da parcela (xTpAjusteBCLocImoveis). Obrigatório quando o tipo é 99. |
Imovel_Ajuste_BC_{n}_Valor | realEstate.propertyUnits[0].baseCalculationAdjustments[].amount | Numérico | Valor total da parcela, sem proporcionalizar (vAjusteBCLocImoveis). |
Bens móveis locados
Use nas notas de locação de bens móveis (código de tributação nacional 99.04.01). Cada bem vira um item de
ibsCbs.movableAssets.Regras de preenchimento:
- A planilha aceita até 5 bens por nota. Troque
{n}pelo número do bem, de 1 a 5. Exemplo:Bem_Movel_1_NCM,Bem_Movel_2_NCM.- Quando qualquer coluna do bem
{n}é preenchida, as três colunas do bem passam a ser obrigatórias.- Bens vazios são pulados. Exemplo: com os bens 1 e 3 preenchidos, a nota leva dois itens em
movableAssets.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Bem_Movel_{n}_NCM | ibsCbs.movableAssets[].ncmCode | Código NCM (8 dígitos) | Código NCM do bem, sem pontos (cNCMBemMovel). Formate a célula como Texto para manter os zeros à esquerda. |
Bem_Movel_{n}_Descricao | ibsCbs.movableAssets[].ncmDescription | Texto livre (máx. 150) | Descrição do NCM do bem (xNCMBemMovel). |
Bem_Movel_{n}_Quantidade | ibsCbs.movableAssets[].quantity | Inteiro de 1 a 999 | Quantidade do bem (qtdNCMBemMovel). |
Condomínio
Use nas notas de operações condominiais (código de tributação nacional 99.05.01). As colunas viram o grupo
ibsCbs.condominium: o vencimento original, as cobranças com o detalhamento de cada uma e os descontos.Regras de preenchimento:
- A planilha aceita até 5 cobranças por nota, até 2 detalhes por cobrança e até 3 descontos por nota. Troque
{n}pelo número da cobrança (1 a 5),{m}pelo número do detalhe (1 a 2) e{k}pelo número do desconto (1 a 3). Exemplo:Condominio_Cobranca_1_Tipo,Condominio_Cobranca_1_Detalhe_2_Tipo,Condominio_Desconto_3_Tipo.- Quando qualquer coluna
Condominio_*é preenchida,Condominio_Vencimento_Originalpassa a ser obrigatória, e a nota precisa de pelo menos 1 cobrança. O vencimento original é um só por nota.- Uma cobrança, um detalhe ou um desconto está preenchido quando qualquer uma das suas três colunas tem valor. No item preenchido, as colunas
TipoeDescricaopassam a ser obrigatórias, em todo tipo. A descrição aceita até 150 caracteres.- A coluna
Valoré opcional em todo item. Quando preenchida, ela aceita somente número maior ou igual a 0.- As colunas
Tipoaceitam somente o código numérico. Exemplo:99, e não99 - Outra.- O detalhe exige a cobrança dele. Um detalhe preenchido com a cobrança
{n}vazia bloqueia a linha.- Itens vazios são pulados. Exemplo: com as cobranças 1 e 3 preenchidas, a nota leva dois itens em
charges. O mesmo vale para os detalhes de cada cobrança e para os descontos.- Uma coluna acima do limite da planilha bloqueia a linha quando está preenchida. Exemplo:
Condominio_Cobranca_6_Tipo,Condominio_Cobranca_1_Detalhe_3_TipoouCondominio_Desconto_4_Tipo. Vazia, a coluna é ignorada.- A API aceita até 20 cobranças, 20 detalhes por cobrança e 10 descontos. Para uma nota com mais itens do que a planilha aceita, emita pela API REST.
- A soma dos valores das cobranças compõe o valor do serviço (
Valor). A planilha não confere essa soma. Confira os valores antes de enviar.- O grupo de condomínio só chega ao XML no leiaute 1.02. No leiaute 1.01, a API ignora o grupo, e a nota é emitida sem ele.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
Condominio_Vencimento_Original | ibsCbs.condominium.originalDueDate | YYYY-MM-DD | Data de vencimento original das cobranças (dVencOrig). Uma por nota. Obrigatório quando qualquer coluna Condominio_* é preenchida. Ex.: 2026-12-10. |
Condominio_Cobranca_{n}_Tipo | ibsCbs.condominium.charges[].type | 1, 2, 3, 4, 5 ou 99 | Tipo da cobrança (tpCobranca). Valores: 1 Ordinário, 2 Privativo, 3 FPP (fundo de promoção e propaganda), 4 Impostos e taxas, 5 Fundo de reserva, 99 Outra. Obrigatório na cobrança preenchida. Ex.: 1. |
Condominio_Cobranca_{n}_Descricao | ibsCbs.condominium.charges[].typeDescription | Texto livre (máx. 150) | Descrição da cobrança (xTpCobranca). Obrigatório na cobrança preenchida, em todo tipo. Ex.: Taxa ordinária. |
Condominio_Cobranca_{n}_Valor | ibsCbs.condominium.charges[].amount | Numérico (mínimo 0) | Valor da cobrança (vCobranca). Opcional. Ex.: 850,00. |
Condominio_Cobranca_{n}_Detalhe_{m}_Tipo | ibsCbs.condominium.charges[].details[].type | Inteiro de 1 a 36 ou 999 | Tipo do detalhe da cobrança (tpDetCobranca). Veja os tipos de detalhe. Obrigatório no detalhe preenchido. Ex.: 23. |
Condominio_Cobranca_{n}_Detalhe_{m}_Descricao | ibsCbs.condominium.charges[].details[].typeDescription | Texto livre (máx. 150) | Descrição do detalhe (xTpDetCobranca). Obrigatório no detalhe preenchido, em todo tipo. Ex.: Limpeza. |
Condominio_Cobranca_{n}_Detalhe_{m}_Valor | ibsCbs.condominium.charges[].details[].amount | Numérico (mínimo 0) | Valor do detalhe, que compõe o valor da cobrança (vDetCobranca). Opcional. Ex.: 300,00. |
Condominio_Desconto_{k}_Tipo | ibsCbs.condominium.discounts[].type | 1 ou 2 | Tipo do desconto (tpDesconto). Valores: 1 Incondicionado, 2 Condicionado. Obrigatório no desconto preenchido. Ex.: 1. |
Condominio_Desconto_{k}_Descricao | ibsCbs.condominium.discounts[].description | Texto livre (máx. 150) | Descrição do desconto (xTpDesconto). Obrigatório no desconto preenchido. Ex.: Desconto por pontualidade. |
Condominio_Desconto_{k}_Valor | ibsCbs.condominium.discounts[].amount | Numérico (mínimo 0) | Valor do desconto (vDesconto). Opcional. Ex.: 35,00. |
Tipos de detalhe da cobrança
Os códigos de Condominio_Cobranca_{n}_Detalhe_{m}_Tipo seguem o Anexo VI da NT 009, na versão do schema 1.02 que a API usa. Esse schema ainda não é a versão oficial, e a lista pode mudar.
Ver os 37 tipos de detalhe
| Código | Tipo de detalhe |
|---|---|
1 | Cond. Comum CRD |
2 | Cond. Comum M2 |
3 | Cond. Comum Fixo |
4 | Cond. Comum Fração |
5 | Cond. Comum Percentual |
6 | Condomínio CMM |
7 | Energia Elétrica |
8 | Água |
9 | Ar Condicionado |
10 | Telefone |
11 | Internet |
12 | Controle de Pragas |
13 | Exaustão |
14 | Gás |
15 | IPTU |
16 | Taxa Área |
17 | Manutenção |
18 | Multa |
19 | Seguro |
20 | Taxa Bombeiro |
21 | Taxa Administração |
22 | Taxa Foro |
23 | Limpeza |
24 | Taxa de Lixo |
25 | Tapume |
26 | Instalação Alarme |
27 | Segurança |
28 | Fundo de Promoção e Propaganda |
29 | Análise de Projeto |
30 | Fundo de Reserva |
31 | Laudos e Vistorias |
32 | Detecção de Fumaça |
33 | Reanálise de Projeto |
34 | Taxa Extra |
35 | Área Vaga |
36 | Condomínio Irrecuperável |
999 | Outro |
Exemplo de preenchimento
Nota fictícia de condomínio (código de tributação nacional 99.05.01) com a taxa ordinária, o fundo de reserva e um desconto por pontualidade:
| Coluna | Valor |
|---|---|
Valor | 935,00 |
Condominio_Vencimento_Original | 2026-12-10 |
Condominio_Cobranca_1_Tipo | 1 |
Condominio_Cobranca_1_Descricao | Taxa ordinária |
Condominio_Cobranca_1_Valor | 850,00 |
Condominio_Cobranca_2_Tipo | 5 |
Condominio_Cobranca_2_Descricao | Fundo de reserva |
Condominio_Cobranca_2_Valor | 85,00 |
Condominio_Desconto_1_Tipo | 1 |
Condominio_Desconto_1_Descricao | Desconto por pontualidade |
Condominio_Desconto_1_Valor | 35,00 |
As demais colunas Condominio_* ficam vazias. A nota leva 2 itens em charges e 1 item em discounts, sem details. A coluna Valor traz a soma das cobranças: 850,00 + 85,00 = 935,00.
NFS-e de ajuste (crédito e débito)
Use para emitir uma NFS-e de ajuste de IBS/CBS, de crédito ou de débito. A situação atual e os cenários estão em NFS-e de ajuste de IBS/CBS.
Regras de preenchimento:
- Com
IBSCBS_Ajuste_Finalidade = Debit,IBSCBS_Ajuste_Tipo_Debitopassa a ser obrigatório, eIBSCBS_Ajuste_Tipo_Creditodeve ficar vazio.- Com
IBSCBS_Ajuste_Finalidade = Credit,IBSCBS_Ajuste_Tipo_Creditopassa a ser obrigatório, eIBSCBS_Ajuste_Tipo_Debitodeve ficar vazio.- Um tipo sem a finalidade correspondente bloqueia a linha.
- Preencha
IBSCBS_Ajuste_IBS_ValoreIBSCBS_Ajuste_CBS_Valorsomente comIBSCBS_Ajuste_Finalidade.- Para referenciar a NFS-e original, use a coluna
IBSCBS_NFSe_Referenciadas.- A API aplica as demais regras de cada tipo, por exemplo, quais tipos exigem a NFS-e referenciada ou os valores de IBS e CBS.
- As três colunas de finalidade e tipo aceitam o valor na API ou o código, sem diferença entre maiúsculas e minúsculas. Exemplo:
Debitou2;FinesAndInterestou04.
| Campo/Coluna | Campo na API | Possíveis Valores | Descrição |
|---|---|---|---|
IBSCBS_Ajuste_Finalidade | ibsCbs.adjustmentPurpose | Credit (1), Debit (2) | Finalidade da NFS-e de ajuste (finNFSe): crédito ou débito. Vazia, a nota é regular. |
IBSCBS_Ajuste_Tipo_Debito | ibsCbs.debitAdjustmentType | CooperativeCreditTransfer (01), CreditAnnulmentExemptOutflows (02), UnprocessedInvoiceDebits (03), FinesAndInterest (04), SuccessionCreditTransfer (05), AdvancePayment (06) | Tipo da nota de débito (tpNFSeDebito). Valores: 01 Transferência de créditos para cooperativas, 02 Anulação de crédito por saídas imunes ou isentas, 03 Débitos de notas fiscais não processadas na apuração, 04 Multa e juros, 05 Transferência de crédito na sucessão, 06 Pagamento antecipado. |
IBSCBS_Ajuste_Tipo_Credito | ibsCbs.creditAdjustmentType | FinesAndInterest (01), SuccessionCreditTransfer (05) | Tipo da nota de crédito (tpNFSeCredito). Valores: 01 Multa e juros, 05 Transferência de crédito na sucessão. |
IBSCBS_Ajuste_IBS_Valor | ibsCbs.adjustment.ibsAmount | Numérico | Valor do IBS a ajustar (grupo gIBSCBSAjuste). |
IBSCBS_Ajuste_CBS_Valor | ibsCbs.adjustment.cbsAmount | Numérico | Valor da CBS a ajustar (grupo gIBSCBSAjuste). |
⚠️ Atenção: Evite adicionar fórmulas, índices ou qualquer tipo de alteração no excel. Isso pode gerar problemas ao capturar os dados do excel.
Próximos passos
Documentação relacionada
- Conceitos sobre NFS-e - Entenda o que é NFS-e, CNAE, Código de Serviço e Inscrição Municipal
- Primeiros passos para integração via API - Para quem deseja integrar via API REST
- Qual código de serviço utilizar? - Dúvidas sobre códigos de serviço
Reforma Tributária (IBS/CBS)
- Documentação do Layout de Emissão de NFS-e (RTC) - Documentação funcional completa do novo layout
- Mudanças no Layout de Integração da NFS-e (v4) - Comparativo entre layouts antigo e novo
- Tabela de CST e Classificação Tributária - Códigos CST e cClassTrib (obrigatório para preencher
IBSCBS_Codigo_ClassificacaoeIBSCBS_Codigo_Situacao) - Tabela de Indicador da Operação - Códigos indOp (obrigatório para preencher
IBSCBS_Indicador_Operacao)