Emitir

Cria uma NFe ABI e a envia para processamento.

O envio é síncrono: na maioria dos casos a NFe ABI é autorizada ou rejeitada na mesma requisição (status HTTP 201). Se o autorizador não responder a tempo, a requisição é aceita para processamento (status HTTP 202) e o resultado deve ser obtido pela operação de consulta. A resposta contém o mesmo formato da operação de consulta.

Abaixo você poderá verificar uma listagem dos principais campos disponíveis. Para verificar a listagem completa de campos veja o link a seguir.

Documentação completa de campos da NF-e ABI

Query Params
string
required

Referência única da NFe ABI

string
enum

Informe 1 para emitir em contingência offline. A NFe ABI é gerada e retornada na hora com status autorizado, contingencia_offline: true e contingencia_offline_efetivada: false; a transmissão ao Ambiente Nacional é feita depois, automaticamente. A data e a justificativa de entrada em contingência (data_entrada_contingencia e motivo_entrada_contingencia) são preenchidas pela API quando não informadas.

Allowed:
Body Params
string
required

CNPJ do emitente (somente números). Identifica a empresa cadastrada no Focus NFe que está emitindo a NFe ABI.

string
required

Razão social ou nome do emitente (2 a 60 caracteres). Em homologação é substituído pelo texto exigido pelo Ambiente Nacional.

string

Nome fantasia do emitente.

string
required

Tipo do emitente, conforme tabela oficial tpEmit (01 a 10 ou 99).

string
required

Logradouro do endereço do emitente.

string
required

Número do endereço do emitente.

string

Complemento do endereço do emitente.

string

Bairro do endereço do emitente.

string

Código IBGE do município do emitente (7 dígitos). Informe o código ou o nome do município; o outro é preenchido automaticamente.

string

Nome do município do emitente. Informe o nome ou o código do município; o outro é preenchido automaticamente.

string
required

Sigla da UF do emitente. Também é usada para localizar a empresa emitente.

string

CEP do endereço do emitente (8 dígitos).

string

Código do país do emitente (tabela BACEN; 1058=Brasil).

string

Nome do país do emitente.

string

Telefone do emitente (7 a 12 dígitos).

string
required

Modalidade da operação, conforme tabela oficial (2 dígitos).

string
required

Natureza da operação, conforme tabela oficial (2 dígitos).

string

Detalhamento da operação, conforme tabela oficial (2 dígitos).

string
enum

Finalidade de emissão. 1=Normal, 2=Substituição. Padrão 1.

Allowed:
string

Série do documento fiscal. Se não informada, será atribuída automaticamente.

string

Número do documento fiscal. Se não informado, será atribuído automaticamente.

string

Data e hora da entrada em contingência (formato AAAA-MM-DDThh:mm:ss±hh:mm). Usada apenas na emissão em contingência offline; se não informada, a API usa a data de emissão.

string

Justificativa da entrada em contingência (15 a 256 caracteres). Usada apenas na emissão em contingência offline; se não informada, a API usa um motivo padrão.

notas_referenciadas
array of objects

NFe ABI referenciadas (0 a 500).

notas_referenciadas
transmitentes
array of objects
required

Transmitentes (vendedores/alienantes) do bem imóvel (1 a 99).

transmitentes*
adquirentes
array of objects
required

Adquirentes (compradores) do bem imóvel (1 a 99).

adquirentes*
string
enum
required

Tipo do imóvel. 1=Urbano, 2=Rural.

Allowed:
string

Código de Cadastro Imobiliário Brasileiro (CIB), de 2 a 60 caracteres.

string
enum

Indicador de existência de IPTU. 0=Não, 1=Sim.

Allowed:
string

Número da inscrição do IPTU.

string
enum

Indicador de existência de registro no INCRA. 0=Não, 1=Sim.

Allowed:
string

Número do registro no INCRA.

string
required

Espécie do imóvel, conforme tabela oficial (2 dígitos). Por exemplo, 01=Terreno, 02=Casa.

string

Descrição da espécie quando imovel_especie=99 (Outros).

string

Enquadramento do imóvel, conforme tabela oficial (2 dígitos).

string
required

Logradouro do endereço do imóvel.

string
required

Número do endereço do imóvel.

string

Complemento do endereço do imóvel.

string

Bairro do endereço do imóvel.

string
required

Código IBGE do município do imóvel (7 dígitos).

string
required

Nome do município do imóvel.

string
required

Sigla da UF do imóvel.

string

CEP do endereço do imóvel (8 dígitos).

string

Código do país do imóvel (tabela BACEN; 1058=Brasil).

string

Nome do país do imóvel.

string

Telefone de contato do imóvel (7 a 12 dígitos).

string

Observação sobre a localização do imóvel (2 a 200 caracteres).

string

Área total do imóvel.

string

Unidade da área total. m2 ou ha.

string

Cartório de registro do imóvel.

string

Número da matrícula ou transcrição.

autorizados_download_xml
array of objects

Autorizados a acessar o XML da NFe ABI (0 a 10).

autorizados_download_xml
string
required

Percentual de transmissão do imóvel (até 4 casas decimais). Exigido pelo Ambiente Nacional.

string
required

Valor total da operação.

string
enum

Indicador de existência de torna. 0=Não, 1=Sim. Informar somente quando houver torna; quando não houver, omitir o campo (o Ambiente Nacional rejeita a presença do indicador sem torna).

Allowed:
string

Valor da torna. Obrigatório quando houver torna.

torna_imoveis
array of objects

Imóveis dados em torna (1 a 30). Obrigatório quando houver torna.

torna_imoveis
string
enum
required

Indicador de venda inicial de lote ou imóvel na planta (incorporação/loteamento/desmembramento). 0=Não, 1=Sim. Exigido pelo Ambiente Nacional.

Allowed:
string

CNPJ da empresa incorporadora/imobiliária (somente números).

string

Código CIB da obra.

string

Valor inicial do imóvel.

string

Valor do ITBI.

string

Valor do laudêmio.

string

Valor da contrapartida.

string

Valor total da redução/ajuste do imóvel. Obrigatório quando informado o grupo de redução/ajuste do imóvel.

string
enum

Indicador de redução social. 0=Não, 1=Sim.

Allowed:
string

Valor da redução social.

string
required

Tipo do instrumento, conforme tabela oficial (2 dígitos). Por exemplo, 01=Contrato particular, 99=Outros.

string

Descrição do instrumento quando tipo_instrumento=99 (Outros).

string
required

Data do instrumento. Formato AAAA-MM-DD.

string
enum

Indicador de intermediação/corretagem. 0=Não, 1=Sim.

Allowed:
intermediarios
array of objects

Intermediários/corretores da operação (0 a 99).

intermediarios
string

Tipo do ente governamental (1 a 4). Obrigatório em compra governamental.

string

Percentual de redutor da alíquota em compra governamental (até 4 casas decimais). Obrigatório em compra governamental.

string

Tipo de operação governamental (1 a 2). Obrigatório em compra governamental.

string
required

Código de Situação Tributária (CST) do IBS/CBS (3 dígitos).

string
required

Código de Classificação Tributária (cClassTrib), 6 dígitos. Deve ser um código aplicável à NFe ABI (coluna indNFeABI=1 da tabela oficial de cClassTrib), por exemplo 200046 (Operações com bens imóveis). O grupo de pagamento (pagamentos_imovel/pagamentos_incorporacao) é proibido quando o cClassTrib não admite pagamento na NFe ABI (rejeição 860).

string

Valor da operação individual. Obrigatório quando informado o grupo IBS/CBS.

string

Valor da torna individual.

string

Valor da redução/ajuste individual.

string

Valor da redução social individual.

string

Base de cálculo do IBS/CBS. Ao informá-la, o grupo IBS/CBS é enviado e passam a ser obrigatórios ibs_cbs_valor_operacao_individual e os campos de alíquota, percentual de redução, alíquota efetiva e valor de ibs_uf, ibs_mun e cbs. O grupo de totais da NFe ABI é calculado automaticamente a partir desses valores.

string

Alíquota do IBS da UF (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Percentual de redução da alíquota do IBS da UF (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota efetiva do IBS da UF (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Valor do IBS da UF. Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota do IBS do município (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Percentual de redução da alíquota do IBS do município (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota efetiva do IBS do município (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Valor do IBS do município. Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota da CBS (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Percentual de redução da alíquota da CBS (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota efetiva da CBS (até 4 casas decimais). Obrigatório quando informado o grupo IBS/CBS.

string

Valor da CBS. Obrigatório quando informado o grupo IBS/CBS.

string

Alíquota do IBS da UF em compra governamental (até 4 casas decimais). Obrigatório quando informado o grupo de tributação de compra governamental.

string

Valor do tributo do IBS da UF em compra governamental. Obrigatório quando informado o grupo de tributação de compra governamental.

string

Alíquota do IBS do município em compra governamental (até 4 casas decimais). Obrigatório quando informado o grupo de tributação de compra governamental.

string

Valor do tributo do IBS do município em compra governamental. Obrigatório quando informado o grupo de tributação de compra governamental.

string

Alíquota da CBS em compra governamental (até 4 casas decimais). Obrigatório quando informado o grupo de tributação de compra governamental.

string

Valor do tributo da CBS em compra governamental. Obrigatório quando informado o grupo de tributação de compra governamental.

string

Valor do IBS de estorno de crédito. Informar junto com cbs_valor_estornado.

string

Valor da CBS de estorno de crédito. Informar junto com ibs_valor_estornado.

pagamentos_imovel
array of objects

Detalhes de pagamento do imóvel (0 a 99). Obrigatório quando incorporacao_lote_indicador=0 ou modalidade_operacao for diferente de 01; proibido quando incorporacao_lote_indicador=1.

pagamentos_imovel
pagamentos_incorporacao
array of objects

Detalhes de pagamento de incorporação/lote - parcelamento (0 a 99). Obrigatório quando incorporacao_lote_indicador=1; proibido quando incorporacao_lote_indicador=0 ou modalidade_operacao for diferente de 01.

pagamentos_incorporacao
string

Informações adicionais de interesse do Fisco (até 5000 caracteres).

string

Informações complementares de interesse do contribuinte (até 5000 caracteres).

observacoes_contribuinte
array of objects

Observações do contribuinte (0 a 10).

observacoes_contribuinte
observacoes_fisco
array of objects

Observações do Fisco (0 a 10).

observacoes_fisco
string
required

CNPJ do responsável técnico (somente números).

string
required

Nome do contato do responsável técnico.

string
required

E-mail do responsável técnico.

string
required

Telefone do responsável técnico (6 a 14 dígitos).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html