Pular para o conteúdo principal
Documentation Powered by Redocly

API Nuvem Fiscal (2.43.0)

Download OpenAPI specification:Download

API para automação comercial e documentos fiscais.

Empresa

Cadastre e administre todas as empresas vinculadas à sua conta.

Listar empresas

Retorna a lista das empresas associadas à sua conta. As empresas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
string

Filtrar pelo CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Cadastrar empresa

Cadastre uma nova empresa (emitente ou prestador) à sua conta.

Authorizations:
jwtoauth2
Request Body schema: application/json
cpf_cnpj
required
string

CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

created_at
string <date-time>

Data/hora em que o objeto foi criado na Nuvem Fiscal. Representado no formato ISO 8601.

A Nuvem Fiscal gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.

updated_at
string <date-time>

Data e hora que o objeto foi alterado pela última vez na Nuvem Fiscal. Representado no formato ISO 8601.

A Nuvem Fiscal gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.

inscricao_estadual
string <= 50 characters

Inscrição estadual da empresa.

inscricao_municipal
string <= 50 characters

Inscrição municipal da empresa.

nome_razao_social
required
string <= 500 characters

Razão social da empresa.

nome_fantasia
string <= 500 characters

Nome fantasia da empresa.

fone
string

Telefone da empresa.

email
required
string

Email da empresa.

required
object (EmpresaEndereco)

Endereço da empresa.

Responses

Request samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "inscricao_estadual": "string",
  • "inscricao_municipal": "string",
  • "nome_razao_social": "string",
  • "nome_fantasia": "string",
  • "fone": "string",
  • "email": "string",
  • "endereco": {
    }
}

Response samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "inscricao_estadual": "string",
  • "inscricao_municipal": "string",
  • "nome_razao_social": "string",
  • "nome_fantasia": "string",
  • "fone": "string",
  • "email": "string",
  • "endereco": {
    }
}

Consultar empresa

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "inscricao_estadual": "string",
  • "inscricao_municipal": "string",
  • "nome_razao_social": "string",
  • "nome_fantasia": "string",
  • "fone": "string",
  • "email": "string",
  • "endereco": {
    }
}

Alterar empresa

Altera o cadastro de uma empresa (emitente/prestador) que esteja associada a sua conta. Nesse método, por tratar-se de um PUT, caso algum campo não seja informado, o valor dele será apagado.

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
cpf_cnpj
required
string

CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

created_at
string <date-time>

Data/hora em que o objeto foi criado na Nuvem Fiscal. Representado no formato ISO 8601.

A Nuvem Fiscal gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.

updated_at
string <date-time>

Data e hora que o objeto foi alterado pela última vez na Nuvem Fiscal. Representado no formato ISO 8601.

A Nuvem Fiscal gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.

inscricao_estadual
string <= 50 characters

Inscrição estadual da empresa.

inscricao_municipal
string <= 50 characters

Inscrição municipal da empresa.

nome_razao_social
required
string <= 500 characters

Razão social da empresa.

nome_fantasia
string <= 500 characters

Nome fantasia da empresa.

fone
string

Telefone da empresa.

email
required
string

Email da empresa.

required
object (EmpresaEndereco)

Endereço da empresa.

Responses

Request samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "inscricao_estadual": "string",
  • "inscricao_municipal": "string",
  • "nome_razao_social": "string",
  • "nome_fantasia": "string",
  • "fone": "string",
  • "email": "string",
  • "endereco": {
    }
}

Response samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "inscricao_estadual": "string",
  • "inscricao_municipal": "string",
  • "nome_razao_social": "string",
  • "nome_fantasia": "string",
  • "fone": "string",
  • "email": "string",
  • "endereco": {
    }
}

Deletar empresa

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Consultar certificado

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "serial_number": "string",
  • "issuer_name": "string",
  • "not_valid_before": "2019-08-24T14:15:22Z",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "thumbprint": "string",
  • "subject_name": "string",
  • "cpf_cnpj": "string",
  • "nome_razao_social": "string"
}

Cadastrar certificado

Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.

  • No parâmetro certificado, envie o binário do certificado digital (.pfx ou .p12) codificado em base64.
Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
certificado
required
string <byte>

Binário do certificado digital (.pfx ou .p12) codificado em base64.

password
required
string

Senha do certificado.

Responses

Request samples

Content type
application/json
{
  • "certificado": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "serial_number": "string",
  • "issuer_name": "string",
  • "not_valid_before": "2019-08-24T14:15:22Z",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "thumbprint": "string",
  • "subject_name": "string",
  • "cpf_cnpj": "string",
  • "nome_razao_social": "string"
}

Deletar certificado

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Upload de certificado

Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.

  • Utilize o content-type igual a multipart/form-data.
  • No parâmetro file, envie o binário do arquivo (.pfx ou .p12) do certificado digital.
  • No parâmetro password, envie a senha do certificado.
Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: multipart/form-data
Input
string <binary>

Responses

Response samples

Content type
application/json
{
  • "serial_number": "string",
  • "issuer_name": "string",
  • "not_valid_before": "2019-08-24T14:15:22Z",
  • "not_valid_after": "2019-08-24T14:15:22Z",
  • "thumbprint": "string",
  • "subject_name": "string",
  • "cpf_cnpj": "string",
  • "nome_razao_social": "string"
}

Consultar configuração de CT-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Alterar configuração de CT-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
CRT
integer
Default: 3

Código de Regime Tributário. Este campo será preenchido com:

  • 1 – Simples Nacional;
  • 2 – Simples Nacional – excesso de sublimite de receita bruta;
  • 3 – Regime Normal;
  • 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Consultar configuração de Distribuição de NF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "distribuicao_automatica": false,
  • "ciencia_automatica": false,
  • "ambiente": "homologacao"
}

Alterar configuração de Distribuição de NF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
distribuicao_automatica
boolean or null
Default: false

Indica se a distribuição automática está habilitada.

Nesse modo, a API da Nuvem Fiscal irá realizar pedidos de distribuição pelo último NSU de forma automática a cada 1 hora.

ciencia_automatica
boolean or null
Default: false

Indica se a manifestação de Ciência da Operação (210210) deve ser feita automaticamente pela API.

Caso habilitada, a manifestação de ciência será realizada para notas recebidas por qualquer forma de consulta ou modo de distribuição (manual ou automático).

ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "distribuicao_automatica": false,
  • "ciencia_automatica": false,
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "distribuicao_automatica": false,
  • "ciencia_automatica": false,
  • "ambiente": "homologacao"
}

Baixar logotipo

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Enviar logotipo

Cadastre ou atualize um logotipo e vincule a sua empresa.

Restrições:

  • Tipos de mídia (MIME) suportados: image/png e image/jpeg
  • Tamanho máximo do arquivo: 200 KB

Cenários de uso:

  • Quero que minhas notas sejam impressas com esse logotipo.
  • Quero trocar o logotipo utilizado em minhas impressões.
Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: multipart/form-data
Input
string <binary>

Responses

Deletar logotipo

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Consultar configuração de MDF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "ambiente": "homologacao"
}

Alterar configuração de MDF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "ambiente": "homologacao"
}

Consultar configuração de NFC-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "sefaz": {
    },
  • "ambiente": "homologacao"
}

Alterar configuração de NFC-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
CRT
integer
Default: 3

Código de Regime Tributário. Este campo será preenchido com:

  • 1 – Simples Nacional;
  • 2 – Simples Nacional – excesso de sublimite de receita bruta;
  • 3 – Regime Normal;
  • 4 - Simples Nacional - Microempreendedor individual (MEI).
required
object (EmpresaConfigNfceSefaz)
ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "CRT": 3,
  • "sefaz": {
    },
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "sefaz": {
    },
  • "ambiente": "homologacao"
}

Consultar configuração de NFCom

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Alterar configuração de NFCom

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
CRT
integer
Default: 3

Código de Regime Tributário. Este campo será preenchido com:

  • 1 – Simples Nacional;
  • 2 – Simples Nacional – excesso de sublimite de receita bruta;
  • 3 – Regime Normal.
ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Consultar configuração de NF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Alterar configuração de NF-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
CRT
integer
Default: 3

Código de Regime Tributário. Este campo será preenchido com:

  • 1 – Simples Nacional;
  • 2 – Simples Nacional – excesso de sublimite de receita bruta;
  • 3 – Regime Normal;
  • 4 - Simples Nacional - Microempreendedor individual (MEI).
ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "CRT": 3,
  • "ambiente": "homologacao"
}

Consultar configuração de NFS-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "regTrib": {
    },
  • "rps": {
    },
  • "prefeitura": {
    },
  • "incentivo_fiscal": false,
  • "ambiente": "homologacao"
}

Alterar configuração de NFS-e

Authorizations:
jwtoauth2
path Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
object (EmpresaConfigNfseRegTrib)

Grupo de informações relativas aos regimes de tributação do prestador de serviços.

required
object (EmpresaConfigRps)

Configuração de numeração de lote, série e RPS.

object (EmpresaConfigPrefeitura)

Dados adicionais para comunicação com a prefeitura. Essa validação é dinâmica, de acordo com a necessidade de cada município.

incentivo_fiscal
boolean
Default: false

Indicador se a empresa possui algum tipo de incentivo fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Request samples

Content type
application/json
{
  • "regTrib": {
    },
  • "rps": {
    },
  • "prefeitura": {
    },
  • "incentivo_fiscal": false,
  • "ambiente": "homologacao"
}

Response samples

Content type
application/json
{
  • "regTrib": {
    },
  • "rps": {
    },
  • "prefeitura": {
    },
  • "incentivo_fiscal": false,
  • "ambiente": "homologacao"
}

Conta

Consultar os limites de uso e consumo de todas as cotas existentes.

Authorizations:
jwtoauth2

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar o limite de uso e o consumo de uma cota específica.

Authorizations:
jwtoauth2
path Parameters
nome
required
string

Nome da cota a ser consultada.

Responses

Response samples

Content type
application/json
{
  • "nome": "string",
  • "consumo": 0,
  • "limite": 0
}

Nfse

Nota Fiscal de Serviço Eletrônica.

Listar NFS-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir NFS-e Deprecated

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

required
object (RpsPedidoEmissao)

Responses

Request samples

Content type
application/json
{
  • "ambiente": "homologacao",
  • "rps": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "processando",
  • "numero": "string",
  • "codigo_verificacao": "string",
  • "link_url": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "DPS": {
    },
  • "cancelamento": {
    },
  • "mensagens": [
    ],
  • "declaracao_prestacao_servico": {
    }
}

Cidades atendidas

Fornece uma relação completa de todos os municípios atendidos pela Nuvem Fiscal.

Authorizations:
jwtoauth2

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar metadados

Consulta a disponibilidade de emissão e alguns metadados de um município.

Authorizations:
jwtoauth2
path Parameters
codigo_ibge
required
string

Código IBGE do município.

Responses

Response samples

Content type
application/json
{
  • "codigo_ibge": "string",
  • "uf": "string",
  • "municipio": "string",
  • "provedor": "string",
  • "ambientes": [
    ],
  • "credenciais": [
    ]
}

Emitir NFS-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
provedor
string
Enum: "padrao" "nacional"

Default: "padrao"

Identificação do provedor para transmissão da DPS:

  • "padrao": Provedor padrão da prefeitura.
  • "nacional": Ambiente de Dados Nacional (ADN) do Sistema Nacional NFS-e.
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

required
object (InfDPS)

Grupo de informações da DPS relativas ao serviço prestado.

Responses

Request samples

Content type
application/json
{
  • "provedor": "padrao",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "infDPS": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "processando",
  • "numero": "string",
  • "codigo_verificacao": "string",
  • "link_url": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "DPS": {
    },
  • "cancelamento": {
    },
  • "mensagens": [
    ],
  • "declaracao_prestacao_servico": {
    }
}

Emitir lote de NFS-e

Informações adicionais:

Authorizations:
jwtoauth2
Request Body schema: application/json
provedor
string
Enum: "padrao" "nacional"

Default: "padrao"

Identificação do provedor para transmissão da DPS:

  • "padrao": Provedor padrão da prefeitura.
  • "nacional": Ambiente de Dados Nacional (ADN) do Sistema Nacional NFS-e.
ambiente
required
string or null
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Array of objects (NfseDpsPedidoEmissao) <= 50 items

Lista com as informações das DPS relativas aos serviços prestados.

Responses

Request samples

Content type
application/json
{
  • "provedor": "padrao",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "documentos": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "novo",
  • "numero": "string",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "notas": [
    ]
}

Listar lotes de NFS-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

referencia
string
ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir lote de NFS-e Deprecated

Informações adicionais:

Authorizations:
jwtoauth2
Request Body schema: application/json
ambiente
required
string or null
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Array of objects (RpsPedidoEmissao) <= 50 items

Responses

Request samples

Content type
application/json
{
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "lista_rps": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "novo",
  • "numero": "string",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "notas": [
    ]
}

Consultar lote de NFS-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do lote gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "novo",
  • "numero": "string",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "notas": [
    ]
}

Baixar XML do evento de cancelamento

Authorizations:
jwtoauth2
path Parameters
Id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Responses

Consultar NFS-e

Consulta os detalhes de uma NFS-e já existente. Forneça o ID único obtido de uma requisição de criação ou de listagem de notas e a Nuvem Fiscal irá retornar as informações da nota correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "processando",
  • "numero": "string",
  • "codigo_verificacao": "string",
  • "link_url": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "DPS": {
    },
  • "cancelamento": {
    },
  • "mensagens": [
    ],
  • "declaracao_prestacao_servico": {
    }
}

Consultar o cancelamento da NFS-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pendente",
  • "codigo": "string",
  • "motivo": "string",
  • "data_hora": "2019-08-24T14:15:22Z",
  • "mensagens": [
    ]
}

Cancelar uma NFS-e autorizada

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
codigo
string

Código de cancelamento, exigido por algumas prefeituras. Para saber quais valores são aceitos, consulte o manual da prefeitura.

motivo
string

Motivo de cancelamento, exigido por algumas prefeituras.

Responses

Request samples

Content type
application/json
{
  • "codigo": "string",
  • "motivo": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pendente",
  • "codigo": "string",
  • "motivo": "string",
  • "data_hora": "2019-08-24T14:15:22Z",
  • "mensagens": [
    ]
}

Baixar PDF do DANFSE

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

mensagem_rodape
string <= 120 characters

Imprime mensagem no rodapé do documento.

O caractere | (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.

Exemplos de Uso:

  • "esquerda"
  • "esquerda|centro"
  • "esquerda|centro|direita"
  • "|centro", "|centro|"
  • "|centro|direita"
  • "||direita"
  • "esquerda||direita"

Default: ""

Responses

Sincroniza dados na NFS-e a partir da Prefeitura

Realiza a sincronização dos dados a partir da consulta da situação atual da NFS-e na prefeitura.

Cenários de uso:

  • Sincronizar uma nota que se encontra com o status processando na Nuvem Fiscal, mas está autorizada na prefeitura;
  • Sincronizar uma nota que se encontra com o status erro na Nuvem Fiscal, mas está autorizada na prefeitura (útil em casos de erros de transmissão, como instabilidades e timeouts);
  • Sincronizar uma nota que se encontra com o status autorizadana Nuvem Fiscal, mas está cancelada na prefeitura.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por evento sincronizado ou requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
identificador
string

Identificador utilizado na consulta da situação atual da NFS-e.

O valor desse campo é opcional para as prefeituras que suportem consultas por número e série do RPS. Para as demais, esse campo torna-se obrigatório e o seu valor pode ser a chave de acesso, número da NFS-e, chave de verificação, protocolo ou outro identificador da nota a depender da prefeitura.

Responses

Request samples

Content type
application/json
{
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "status": "pendente",
  • "mensagens": [
    ]
}

Baixar XML da NFS-e processada

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Responses

Baixar XML da DPS

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFS-e gerado pela Nuvem Fiscal.

Responses

Nfcom

Nota Fiscal Fatura de Serviço de Comunicação Eletrônica.

Listar NFCom

Retorna a lista de NFCom de acordo com os critérios de busca utilizados. As NFCom são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir NFCom

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (NfcomSefazInfNFCom)

Informações da NFCom.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFCom": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

autorizador
string

Ambiente Autorizador.

Autorizadores disponíveis: SVRS.

Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response samples

Content type
application/json
{
  • "autorizador": "AM",
  • "ambiente": "homologacao",
  • "data_hora_consulta": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "tempo_medio_resposta": 0,
  • "data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar NFCom

Consulta os detalhes de uma NFCom já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de NFCom e a Nuvem Fiscal irá retornar as informações da NFCom correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar o cancelamento da NFCom

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Cancelar uma NFCom autorizada

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Request Body schema: application/json
justificativa
string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Request samples

Content type
application/json
{
  • "justificativa": "string"
}

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar XML do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Baixar XML da NFCom processada

Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz nfcomProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfcom/{id}/xml/nota.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Baixar XML da NFCom

Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Baixar XML do Protocolo da SEFAZ

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFCom gerada pela Nuvem Fiscal.

Responses

Cte

Conhecimento de Transporte Eletrônico.

Listar CT-e

Retorna a lista de CT-e de acordo com os critérios de busca utilizados. Os CT-e são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir CT-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (CteSefazInfCte)

Informações do CT-e.

object (CteSefazInfCTeSupl)

Informações suplementares do CT-e.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infCte": {
    },
  • "infCTeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

autorizador
string

Ambiente Autorizador.

Autorizadores disponíveis: MT, MS, MG, PR, RS, SP, SVRS, SVSP, AN.

Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response samples

Content type
application/json
{
  • "autorizador": "AM",
  • "ambiente": "homologacao",
  • "data_hora_consulta": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "tempo_medio_resposta": 0,
  • "data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar CT-e

Consulta os detalhes de um CT-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de CT-e e a Nuvem Fiscal irá retornar as informações do CT-e correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar o cancelamento do CT-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Cancelar um CT-e autorizado

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
justificativa
string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Request samples

Content type
application/json
{
  • "justificativa": "string"
}

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Consultar a solicitação de correção do CT-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "correcoes": [
    ],
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Solicitar correção do CT-e

É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
required
Array of objects (CteInfCorrecao) non-empty

Grupo de Informações de Correção.

Array (non-empty)
grupo_alterado
required
string [ 1 .. 20 ] characters

Indicar o grupo de informações que pertence o "campo_alterado". Ex: ide.

campo_alterado
required
string [ 1 .. 20 ] characters

Nome do campo modificado do CT-e Original.

valor_alterado
required
string [ 1 .. 500 ] characters

Valor correspondente à alteração.

numero_item_alterado
integer or null

Preencher com o indice do item alterado caso a alteração ocorra em uma lista. OBS: O indice inicia sempre em 1.

Responses

Request samples

Content type
application/json
{
  • "correcoes": [
    ]
}

Response samples

Content type
application/json
{
  • "correcoes": [
    ],
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF da carta de correção

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Baixar XML da carta de correção

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Baixar PDF do DACTE

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Sincroniza dados no CT-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da CT-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

  • Sincronizar um CT-e que se encontra com o status erro na Nuvem Fiscal, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
  • Sincronizar um CT-e que se encontra com o status autorizadona Nuvem Fiscal, mas está cancelado na SEFAZ.
  • Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e que porventura não tenham sido feitos a partir da Nuvem Fiscal.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por evento sincronizado ou requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "status": "pendente",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "chave": "string"
}

Baixar XML do CT-e processado

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz cteProc).

O XML só estará disponível nesse endpoint caso o conhecimento tenha sido autorizado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /cte/{id}/xml/conhecimento.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do CT-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do CT-e

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que o conhecimento tenha sido rejeitado.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da CT-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do Protocolo da SEFAZ

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da CT-e gerado pela Nuvem Fiscal.

Responses

Mdfe

Manifesto Eletrônico de Documentos Fiscais.

Listar MDF-e

Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir MDF-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (MdfeSefazInfMDFe)

Informações do MDF-e.

object (MdfeSefazInfMDFeSupl)

Informações suplementares do MDF-e.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infMDFe": {
    },
  • "infMDFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar evento do MDF-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Listar lotes de MDF-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

referencia
string
ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir lote de MDF-e

Informações adicionais:

Authorizations:
jwtoauth2
Request Body schema: application/json
Array of objects (MdfePedidoEmissao) = 1 items
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string <= 50 characters

Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

id_lote
required
string

Responses

Request samples

Content type
application/json
{
  • "documentos": [
    ],
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Consultar lote de MDF-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do lote gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Consulta MDF-e não encerrados

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

Responses

Response samples

Content type
application/json
{
  • "tpAmb": 0,
  • "verAplic": "string",
  • "cStat": 0,
  • "xMotivo": "string",
  • "cUF": 0,
  • "infMDFe": [
    ]
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

autorizador
string

Ambiente Autorizador.

Autorizadores disponíveis: SVRS.

Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response samples

Content type
application/json
{
  • "autorizador": "AM",
  • "ambiente": "homologacao",
  • "data_hora_consulta": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "tempo_medio_resposta": 0,
  • "data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar manifesto

Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a Nuvem Fiscal irá retornar as informações do manifesto correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar o cancelamento do MDF-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Cancelar um MDF-e autorizado

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json

Dados do cancelamento.

justificativa
string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Request samples

Content type
application/json
{
  • "justificativa": "string"
}

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Consultar encerramento do MDF-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "data_encerramento": "2019-08-24",
  • "uf": "string",
  • "codigo_municipio": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Encerrar um MDF-e autorizado

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
data_encerramento
string or null <date>

Data que o manifesto foi encerrado.

Opcional. Caso não seja informada, será utilizada a data em que a solicitação foi feita à API.

uf
required
string

UF de encerramento do manifesto.

codigo_municipio
required
string

Código IBGE do Município de encerramento do manifesto.

Responses

Request samples

Content type
application/json
{
  • "data_encerramento": "2019-08-24",
  • "uf": "string",
  • "codigo_municipio": "string"
}

Response samples

Content type
application/json
{
  • "data_encerramento": "2019-08-24",
  • "uf": "string",
  • "codigo_municipio": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do encerramento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do encerramento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Incluir um condutor em um MDF-e autorizado

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
nome_condutor
required
string [ 2 .. 60 ] characters

Nome do condutor.

cpf_condutor
required
string

CPF do condutor.

Responses

Request samples

Content type
application/json
{
  • "nome_condutor": "string",
  • "cpf_condutor": "string"
}

Response samples

Content type
application/json
{
  • "nome_condutor": "string",
  • "cpf_condutor": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Incluir um DF-e em um MDF-e autorizado

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
codigo_municipio_carrega
string

Código do Município de carregamento.

municipio_carrega
string

Nome do Município de carregamento.

Array of objects (MdfeDocumentoVinculado)

Informações dos documentos fiscais vinculados ao manifesto.

protocolo_autorizacao
string

Responses

Request samples

Content type
application/json
{
  • "codigo_municipio_carrega": "string",
  • "municipio_carrega": "string",
  • "documentos": [
    ],
  • "protocolo_autorizacao": "string"
}

Response samples

Content type
application/json
{
  • "codigo_municipio_carrega": "string",
  • "municipio_carrega": "string",
  • "documentos": [
    ],
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do DAMDFE

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Sincroniza dados no MDF-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

  • Sincronizar um manifesto que se encontra com o status erro na Nuvem Fiscal, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
  • Sincronizar um manifesto que se encontra com o status autorizadona Nuvem Fiscal, mas está cancelado ou encerrado na SEFAZ.
  • Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da Nuvem Fiscal.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por evento sincronizado ou requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "status": "pendente",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "chave": "string"
}

Baixar XML do MDF-e processado

Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz mdfeProc).

O XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /mdfe/{id}/xml/manifesto.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do MDF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do MDF-e

Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da MDF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do Protocolo da SEFAZ

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da MDF-e gerado pela Nuvem Fiscal.

Responses

Nfe

Nota Fiscal Eletrônica.

Listar NF-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir NF-e

Este endpoint permite a emissão de Notas Fiscais Eletrônicas (NF-e). A solicitação deve ser feita enviando os dados necessários para a emissão de uma NF-e.

A estrutura do JSON utilizado na solicitação segue a hierarquia e nomenclatura de campos definidos no Manual de Orientação ao Contribuinte (MOC). Esta conformidade visa facilitar a integração de novos usuários que já possuem familiaridade com o padrão, além de permitir a resolução de dúvidas diretamente no MOC, com um profissional de contabilidade habilitado ou em outras fontes confiáveis que tratam do mesmo assunto.

Comportamento Assíncrono

A resposta desse endpoint inclui a propriedade status no JSON. Caso o valor retornado seja pendente, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint Consultar NF-e até que seja retornado um status indicando o fim da emissão.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar contribuinte

Consulta o Cadastro Centralizado de Contribuintes (CCC) do ICMS da unidade federada.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

uf
string

Sigla da UF consultada.

Utilize SU para SUFRAMA.

Caso não seja informada, será utilizada a UF da empresa.

argumento
required
string

Argumento de pesquisa.

Valores válidos:

  • CNPJ
  • CPF
  • IE
documento
required
string

Documento a ser consultado (CNPJ, CPF ou Inscrição Estadual).

Responses

Response samples

Content type
application/json
{
  • "codigo_status": 999,
  • "motivo_status": "string",
  • "uf": "string",
  • "ie": "string",
  • "cnpj": "string",
  • "cpf": "string",
  • "data_consulta": "2019-08-24T14:15:22Z",
  • "uf_atendimento": 0,
  • "informacoes_cadastrais": [
    ]
}

Listar eventos

Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

dfe_id
required
string

ID único gerado pela Nuvem Fiscal para o documento fiscal.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Inutilizar uma sequência de numeração de NF-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

cnpj
required
string

CNPJ do emitente.

ano
required
integer

Ano de inutilização da numeração.

serie
required
integer [ 0 .. 999 ]

Série da NF-e.

numero_inicial
required
integer [ 1 .. 999999999 ]

Número da NF-e inicial.

numero_final
required
integer [ 1 .. 999999999 ]

Número da NF-e final.

justificativa
required
string [ 15 .. 255 ] characters

Justificativa do pedido de inutilização.

Responses

Request samples

Content type
application/json
{
  • "ambiente": "homologacao",
  • "cnpj": "string",
  • "ano": 0,
  • "serie": 999,
  • "numero_inicial": 1,
  • "numero_final": 1,
  • "justificativa": "stringstringstr"
}

Response samples

Content type
application/json
{
  • "cnpj": "string",
  • "ano": 0,
  • "modelo": 0,
  • "serie": 0,
  • "numero_inicial": 0,
  • "numero_final": 0,
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Consultar a inutilização de sequência de numeração

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "cnpj": "string",
  • "ano": 0,
  • "modelo": 0,
  • "serie": 0,
  • "numero_inicial": 0,
  • "numero_final": 0,
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF da inutilização

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML da inutilização

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Listar lotes de NF-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

referencia
string
ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir lote de NF-e

Informações adicionais:

Authorizations:
jwtoauth2
Request Body schema: application/json
required
Array of objects (NfePedidoEmissao) [ 1 .. 50 ] items
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string <= 50 characters

Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

id_lote
required
string

Responses

Request samples

Content type
application/json
{
  • "documentos": [
    ],
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Consultar lote de NF-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do lote gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Prévia do PDF do DANFE

Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do DANFE.

Os dados de entrada são os mesmos do endpoint de emissão de NF-e (POST /nfe).

Atenção: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

nome_fantasia
boolean
Default: false

Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.

formato
string
Default: "padrao"

Formato de impressão do DANFE.

Valores disponíveis:

  • padrao: será utilizado o formato definido no XML da NF-e (tag "tpImp");
  • retrato: tamanho A4 em modo retrato;
  • paisagem: tamanho A4 em modo paisagem;
  • simplificado: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11);
  • etiqueta: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).
mensagem_rodape
string <= 120 characters
Default: ""

Imprime mensagem no rodapé do documento.

O caractere | (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.

Exemplos de Uso:

  • "esquerda"
  • "esquerda|centro"
  • "esquerda|centro|direita"
  • "|centro", "|centro|"
  • "|centro|direita"
  • "||direita"
  • "esquerda||direita"
canhoto
boolean
Default: true

Imprime o documento com o bloco de canhoto.

Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Prévia do XML da NF-e

Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do XML, sem a assinatura digital.

Os dados de entrada são os mesmos do endpoint de emissão de NF-e (POST /nfe).

Atenção: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 7.0, item 5.5.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

autorizador
string

Ambiente Autorizador.

Autorizadores disponíveis: AM, BA, GO, MG, MS, MT, PE, PR, RS, SP, SVAN, SVRS, SVCAN, SVCRS, AN.

Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response samples

Content type
application/json
{
  • "autorizador": "AM",
  • "ambiente": "homologacao",
  • "data_hora_consulta": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "tempo_medio_resposta": 0,
  • "data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar NF-e

Consulta os detalhes de uma NF-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a Nuvem Fiscal irá retornar as informações da nota correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar o cancelamento da NF-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Cancelar uma NF-e autorizada

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
justificativa
string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Request samples

Content type
application/json
{
  • "justificativa": "string"
}

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Consultar a solicitação de correção da NF-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "correcao": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Solicitar correção da NF-e

É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json

Contém os dados do pedido para carta de correção.

correcao
string <= 1000 characters

Correção a ser considerada.

Responses

Request samples

Content type
application/json
{
  • "correcao": "string"
}

Response samples

Content type
application/json
{
  • "correcao": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF da carta de correção

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML da carta de correção

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Enviar e-mail

Envia o XML e PDF da nota via email.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
Array of objects (EnderecoEmail) <= 10 items

Lista de endereços de email para envio dos arquivos.

Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.

Array (<= 10 items)
email
required
string

Email do destinatário.

Responses

Request samples

Content type
application/json
{
  • "destinatarios": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pending",
  • "status_message": "string"
}

Baixar PDF do DANFE

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

nome_fantasia
boolean
Default: false

Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.

formato
string
Default: "padrao"

Formato de impressão do DANFE.

Valores disponíveis:

  • padrao: será utilizado o formato definido no XML da NF-e (tag "tpImp");
  • retrato: tamanho A4 em modo retrato;
  • paisagem: tamanho A4 em modo paisagem;
  • simplificado: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11);
  • etiqueta: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).
mensagem_rodape
string <= 120 characters
Default: ""

Imprime mensagem no rodapé do documento.

O caractere | (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.

Exemplos de Uso:

  • "esquerda"
  • "esquerda|centro"
  • "esquerda|centro|direita"
  • "|centro", "|centro|"
  • "|centro|direita"
  • "||direita"
  • "esquerda||direita"
canhoto
boolean
Default: true

Imprime o documento com o bloco de canhoto.

Responses

Sincroniza dados na NF-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

  • Sincronizar uma nota que se encontra com o status erro na Nuvem Fiscal, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
  • Sincronizar uma nota que se encontra com o status autorizadona Nuvem Fiscal, mas está cancelada na SEFAZ.
  • Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da Nuvem Fiscal.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por evento sincronizado ou requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "status": "pendente",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "chave": "string"
}

Baixar XML da NF-e processada

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz nfeProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfe/{id}/xml/nota.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML da NF-e

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do Protocolo da SEFAZ

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NF-e gerado pela Nuvem Fiscal.

Responses

Nfce

Nota Fiscal de Consumidor Eletrônica.

Listar NFC-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente.

Utilize o valor sem máscara.

referencia
string

Seu identificador único para o documento.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

chave
string

Chave de acesso do DF-e.

serie
string

Série do DF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir NFC-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Listar eventos

Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

dfe_id
required
string

ID único gerado pela Nuvem Fiscal para o documento fiscal.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML do evento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Inutilizar uma sequência de numeração de NFC-e

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

cnpj
required
string

CNPJ do emitente.

ano
required
integer

Ano de inutilização da numeração.

serie
required
integer [ 0 .. 999 ]

Série da NF-e.

numero_inicial
required
integer [ 1 .. 999999999 ]

Número da NF-e inicial.

numero_final
required
integer [ 1 .. 999999999 ]

Número da NF-e final.

justificativa
required
string [ 15 .. 255 ] characters

Justificativa do pedido de inutilização.

Responses

Request samples

Content type
application/json
{
  • "ambiente": "homologacao",
  • "cnpj": "string",
  • "ano": 0,
  • "serie": 999,
  • "numero_inicial": 1,
  • "numero_final": 1,
  • "justificativa": "stringstringstr"
}

Response samples

Content type
application/json
{
  • "cnpj": "string",
  • "ano": 0,
  • "modelo": 0,
  • "serie": 0,
  • "numero_inicial": 0,
  • "numero_final": 0,
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Consultar a inutilização de sequência de numeração

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "cnpj": "string",
  • "ano": 0,
  • "modelo": 0,
  • "serie": 0,
  • "numero_inicial": 0,
  • "numero_final": 0,
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF da inutilização

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Baixar XML da inutilização

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do evento gerado pela Nuvem Fiscal.

Responses

Listar lotes de NFC-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

referencia
string
ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Emitir lote de NFC-e

Informações adicionais:

Authorizations:
jwtoauth2
Request Body schema: application/json
required
Array of objects (NfePedidoEmissao) [ 1 .. 50 ] items
ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string <= 50 characters

Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

id_lote
required
string

Responses

Request samples

Content type
application/json
{
  • "documentos": [
    ],
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Consultar lote de NFC-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do lote gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "ambiente": "homologacao",
  • "referencia": "string",
  • "id_lote": "string",
  • "recibo": {
    },
  • "documentos": [
    ]
}

Prévia do PDF do DANFCE

Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do DANFCE.

Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (POST /nfce).

Atenção: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

nome_fantasia
boolean
Default: false

Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.

mensagem_rodape
string <= 120 characters
Default: ""

Imprime mensagem no rodapé do documento.

O caractere | (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.

Exemplos de Uso:

  • "esquerda"
  • "esquerda|centro"
  • "esquerda|centro|direita"
  • "|centro", "|centro|"
  • "|centro|direita"
  • "||direita"
  • "esquerda||direita"
resumido
boolean
Default: false

Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.

qrcode_lateral
boolean
Default: false

Imprime o QRCode na lateral do DANFE NFC-e.

Disponível apenas para DANFE com 80 milímetros de largura.

largura
integer [ 40 .. 80 ]
Default: 80

Largura do DANFE NFC-e (em milímetros).

margem
string
Default: "2"

Define as margens do DANFE NFC-e (em milímetros).

Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre 0 e 9.

  • Quando um valor é especificado, a mesma margem é aplicada para todos os quatro lados.
  • Quando dois valores são especificados, a primeira margem é aplicada aos lados esquerdo e direito, e a segunda aos lados superior e inferior.
  • Quando três valores são especificados, a primeira margem é aplicada ao lado esquerdo, a segunda aos lados superior e inferior, e a terceira ao lado direito.
  • Quando quatro valores são especificados, as margens são aplicadas aos lados esquerdo, superior, direito e inferior, nesta ordem (sentido horário).

Exemplos de uso:

  • margem=1
    • Margem esquerda: 1mm
    • Margem superior: 1mm
    • Margem direita: 1mm
    • Margem inferior: 1mm
  • margem=1,2
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 1mm
    • Margem inferior: 2mm
  • margem=1,2,3
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 3mm
    • Margem inferior: 2mm
  • margem=1,2,3,4
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 3mm
    • Margem inferior: 4mm
Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Prévia do XML da NFC-e

Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do XML, sem a assinatura digital.

Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (POST /nfce).

Atenção: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
required
object (NfeSefazInfNFe)

Informações da Nota Fiscal eletrônica.

object (NfeSefazInfNFeSupl)

Informações suplementares Nota Fiscal.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

referencia
string or null <= 50 characters

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Request samples

Content type
application/json
{
  • "infNFe": {
    },
  • "infNFeSupl": {
    },
  • "ambiente": "homologacao",
  • "referencia": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 7.0, item 5.5.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:
jwtoauth2
query Parameters
cpf_cnpj
required
string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

autorizador
string

Ambiente Autorizador.

Autorizadores disponíveis: AM, BA, CE, GO, MG, MS, MT, PE, PR, RS, SP, SVRS.

Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response samples

Content type
application/json
{
  • "autorizador": "AM",
  • "ambiente": "homologacao",
  • "data_hora_consulta": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "tempo_medio_resposta": 0,
  • "data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar NFC-e

Consulta os detalhes de uma NFC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a Nuvem Fiscal irá retornar as informações da nota correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ambiente": "homologacao",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "pendente",
  • "referencia": "string",
  • "data_emissao": "2019-08-24T14:15:22Z",
  • "modelo": 0,
  • "serie": 0,
  • "numero": 0,
  • "tipo_emissao": 0,
  • "valor_total": 0,
  • "chave": "string",
  • "autorizacao": {
    }
}

Consultar o cancelamento da NFC-e

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Cancelar uma NFC-e autorizada

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
justificativa
string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Request samples

Content type
application/json
{
  • "justificativa": "string"
}

Response samples

Content type
application/json
{
  • "justificativa": "string",
  • "id": "string",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "autor": {
    },
  • "chave_acesso": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string",
  • "codigo_mensagem": 0,
  • "mensagem": "string",
  • "tipo_evento": "string"
}

Baixar PDF do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do cancelamento

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Enviar e-mail

Envia o XML e PDF da nota via email.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Request Body schema: application/json
Array of objects (EnderecoEmail) <= 10 items

Lista de endereços de email para envio dos arquivos.

Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.

Array (<= 10 items)
email
required
string

Email do destinatário.

Responses

Request samples

Content type
application/json
{
  • "destinatarios": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pending",
  • "status_message": "string"
}

Comandos ESC/POS para impressão do DANFCE

ESC/POS é um sistema de comando criado pela Epson usado em diversos sistemas de impressoras POS.

Com o formato ESC/POS, você poderá imprimir nativamente em uma vasta quantidade de modelos de impressora térmicas utilizadas no Brasil e no mundo. Com ela, você consegue fazer o envio de comandos em ESC/POS direto para a porta da impressora.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

query Parameters
modelo
integer [ 0 .. 13 ]
Default: 1

Modelo da impressora:

  • 0 - Texto
  • 1 - Epson
  • 2 - Bematech
  • 3 - Daruma
  • 4 - Vox
  • 5 - Diebold
  • 6 - Epson P2
  • 7 - CustomPos
  • 8 - Star
  • 9 - Zjiang
  • 10 - GPrinter
  • 11 - Datecs
  • 12 - Sunmi
  • 13 - Externo
colunas
integer
Default: 48

Define o máximo de caracteres, em uma linha, usando a fonte normal.

Ex: 40, 42, 48, 58, 80.

qrcode_lateral
boolean
Default: false

Imprime o QRCode na lateral do DANFCe.

OBS: não suportado por alguns modelos de impressora.

Responses

Baixar PDF do DANFCE

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

query Parameters
logotipo
boolean
Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

nome_fantasia
boolean
Default: false

Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.

mensagem_rodape
string <= 120 characters
Default: ""

Imprime mensagem no rodapé do documento.

O caractere | (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.

Exemplos de Uso:

  • "esquerda"
  • "esquerda|centro"
  • "esquerda|centro|direita"
  • "|centro", "|centro|"
  • "|centro|direita"
  • "||direita"
  • "esquerda||direita"
resumido
boolean
Default: false

Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.

qrcode_lateral
boolean
Default: false

Imprime o QRCode na lateral do DANFE NFC-e.

Disponível apenas para DANFE com 80 milímetros de largura.

largura
integer [ 40 .. 80 ]
Default: 80

Largura do DANFE NFC-e (em milímetros).

margem
string
Default: "2"

Define as margens do DANFE NFC-e (em milímetros).

Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre 0 e 9.

  • Quando um valor é especificado, a mesma margem é aplicada para todos os quatro lados.
  • Quando dois valores são especificados, a primeira margem é aplicada aos lados esquerdo e direito, e a segunda aos lados superior e inferior.
  • Quando três valores são especificados, a primeira margem é aplicada ao lado esquerdo, a segunda aos lados superior e inferior, e a terceira ao lado direito.
  • Quando quatro valores são especificados, as margens são aplicadas aos lados esquerdo, superior, direito e inferior, nesta ordem (sentido horário).

Exemplos de uso:

  • margem=1
    • Margem esquerda: 1mm
    • Margem superior: 1mm
    • Margem direita: 1mm
    • Margem inferior: 1mm
  • margem=1,2
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 1mm
    • Margem inferior: 2mm
  • margem=1,2,3
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 3mm
    • Margem inferior: 2mm
  • margem=1,2,3,4
    • Margem esquerda: 1mm
    • Margem superior: 2mm
    • Margem direita: 3mm
    • Margem inferior: 4mm

Responses

Sincroniza dados na NFC-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da NFC-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

  • Sincronizar uma nota que se encontra com o status erro na Nuvem Fiscal, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
  • Sincronizar uma nota que se encontra com o status autorizadona Nuvem Fiscal, mas está cancelada na SEFAZ.
  • Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da Nuvem Fiscal.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por evento sincronizado ou requisição.
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "status": "pendente",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "chave": "string"
}

Baixar XML da NFC-e processada

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz nfeProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfce/{id}/xml/nota.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Baixar XML da NFC-e

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Baixar XML do Protocolo da SEFAZ

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da NFC-e gerado pela Nuvem Fiscal.

Responses

Distribuição NF-e

O processo de distribuição de DFe envolve a disponibilização dos documentos fiscais eletrônicos para os envolvidos na transação (emitentes, destinatários e terceiros autorizados). Ele permite que os destinatários recebam as NF-e emitidas contra o seu CNPJ diretamente do Ambiente Nacional, facilitando o controle e a gestão dos documentos recebidos.

Listar distribuições

Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados. As distribuições são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.

Utilize o valor sem máscara.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Distribuir documentos

Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse. A distribuição pode ser feita de três formas: dist-nsu, cons-nsu e cons-chave.

Formas de Consulta:

  • dist-nsu: Consulta pelo último NSU recebido.
  • cons-nsu: Consulta por um NSU específico.
  • cons-chave: Consulta pela chave de acesso da NF-e.

Retorno da Solicitação

A resposta da solicitação inclui a propriedade status no JSON, que pode ter os seguintes valores:

  • processando: A solicitação está em andamento.
  • concluido: A solicitação foi processada com sucesso.
  • erro: Ocorreu um erro no processamento da solicitação.

Se o status retornado for processando, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint consultar distribuição até que a API retorne o pedido com um status indicando o fim do processamento (concluido ou erro).

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por documento distribuído (retornado) ou requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json
cpf_cnpj
required
string

CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

uf_autor
string or null

Sigla da UF do autor.

tipo_consulta
required
string
Enum: "dist-nsu" "cons-nsu" "cons-chave"

Tipo de consulta.

Valores possíveis:

  • dist-nsu - Consulta pelo último NSU recebido.
  • cons-nsu - Consulta por um NSU específico.
  • cons-chave - Consulta pela chave de acesso da NF-e.
dist_nsu
integer or null

Distribuição de conjunto de DF-e a partir do NSU informado.

Obrigatório quando "tipo_consulta" for "dist-nsu".

cons_nsu
integer or null

Consulta DF-e vinculado ao NSU informado.

Obrigatório quando "tipo_consulta" for "cons-nsu".

cons_chave
string or null

Consulta de NF-e por chave de acesso informada.

Obrigatório quando "tipo_consulta" for "cons-chave".

Responses

Request samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "ambiente": "homologacao",
  • "uf_autor": "string",
  • "tipo_consulta": "dist-nsu",
  • "dist_nsu": 0,
  • "cons_nsu": 0,
  • "cons_chave": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "processando",
  • "ambiente": "homologacao",
  • "uf_autor": "string",
  • "tipo_consulta": "dist-nsu",
  • "dist_nsu": 0,
  • "cons_nsu": 0,
  • "cons_chave": "string",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_hora_resposta": "2019-08-24T14:15:22Z",
  • "ultimo_nsu": 0,
  • "max_nsu": 0,
  • "documentos": [
    ]
}

Listar documentos

Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados. Os documentos são retornadas ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.

Utilize o valor sem máscara.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

dist_nsu
integer

Filtra por documentos a partir do NSU informado.

tipo_documento
string

Filtrar pelo tipo do documento de interesse da pessoa ou empresa.

Valores aceitos: nota, evento

forma_distribuicao
string

Filtrar por documentos que foram distribuídos em sua forma resumida ou completa.

Valores aceitos: resumida, completa

chave_acesso
string

Filtrar pela chave de acesso da NF-e.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar documento

Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do documento gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nsu": 0,
  • "schema": "string",
  • "tipo_documento": "nota",
  • "chave_acesso": "string",
  • "resumo": true,
  • "tipo_evento": "string",
  • "numero_sequencial": 0,
  • "data_evento": "2019-08-24T14:15:22Z",
  • "data_recebimento": "2019-08-24T14:15:22Z",
  • "numero_protocolo": "string",
  • "tipo_nfe": 0,
  • "valor_nfe": 0,
  • "digest_value": "string",
  • "emitente_cpf_cnpj": "string",
  • "emitente_nome_razao_social": "string",
  • "emitente_inscricao_estadual": "string"
}

Baixar PDF do documento

Utilize esse endpoint para obter o PDF do documento.

Schemas suportados:

  • procNFe_v4.00.xsd
Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do documento gerado pela Nuvem Fiscal.

Responses

Baixar XML do documento

Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do documento gerado pela Nuvem Fiscal.

Responses

Listar Manifestações

Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados. As manifestações são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ do autor do evento.

Utilize o valor sem máscara.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Manifestar nota

O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais. Ele envolve eventos que indicam se a operação foi confirmada, desconhecida ou não realizada.

Os seguintes tipos de manifestação são suportados pela NF-e:

  • Confirmação da Operação (210200): Manifestação do destinatário confirmando que a operação descrita na NF-e ocorreu exatamente como informado na NF-e. Esse evento libera a possibilidade de download da NF-e pelo destinatário e impede que a empresa emitente cancele a NF-e após a confirmação.
  • Ciência da Operação (210210): Declara que o destinatário tem ciência da existência da NF-e, mas ainda não possui elementos suficientes para manifestar-se conclusivamente. Este é um evento opcional que pode ser usado pelo destinatário para indicar que está ciente da NF-e enquanto coleta mais informações. Esse evento libera a possibilidade de download da NF-e pelo destinatário.
  • Desconhecimento da Operação (210220): Manifestação do destinatário declarando que a operação descrita da NF-e não foi por ele solicitada.
  • Operação não Realizada (210240): Manifestação do destinatário reconhecendo sua participação na operação descrita na NF-e, mas declarando que a operação não ocorreu ou não se efetivou como informado nesta NF-e.

Informações adicionais:

  • Cota: dfe-eventos
  • Consumo: 1 unidade por requisição.
Authorizations:
jwtoauth2
Request Body schema: application/json

Contém os dados do pedido para manifestação do destinatário.

cpf_cnpj
required
string

CPF ou CNPJ do autor do evento.

Utilize o valor sem máscara.

ambiente
required
string
Enum: "homologacao" "producao"

Identificação do Ambiente.

chave_acesso
required
string

Chave de Acesso da NF-e.

tipo_evento
required
string

Tipo do evento de manifestação do destinatário.

Valores disponíveis:

  • 210200 - Confirmação da operação;
  • 210210 - Ciência da operação;
  • 210220 - Desconhecimento da operação;
  • 210240 - Operação não realizada.
justificativa
string or null [ 15 .. 255 ] characters

Justificativa para o desconhecimento ou não-realização da operação.

Nota: Campo obrigatório para o evento 210240 (operação não realizada).

Responses

Request samples

Content type
application/json
{
  • "cpf_cnpj": "string",
  • "ambiente": "homologacao",
  • "chave_acesso": "string",
  • "tipo_evento": "string",
  • "justificativa": "stringstringstr"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "cpf_cnpj_autor": "string",
  • "chave_acesso": "string",
  • "tipo_evento": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "justificativa": "string",
  • "data_registro": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string"
}

Consultar manifestação

Consulta os detalhes de uma manifestação de NF-e já existente. Forneça o ID único obtido de uma requisição de manifestação ou de listagem de manifestações e a Nuvem Fiscal irá retornar as informações da manifestação correspondente.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da manifestação gerado pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ambiente": "homologacao",
  • "status": "pendente",
  • "cpf_cnpj_autor": "string",
  • "chave_acesso": "string",
  • "tipo_evento": "string",
  • "data_evento": "2019-08-24T14:15:22Z",
  • "numero_sequencial": 0,
  • "justificativa": "string",
  • "data_registro": "2019-08-24T14:15:22Z",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "numero_protocolo": "string"
}

Listar notas sem manifestação

No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida. Para obter o XML completo, o destinatário deve manifestar a ciência da operação e, posteriormente, uma manifestação conclusiva dentro de um prazo legal.

Para facilitar essa gestão e o cumprimento dos prazos legais de manifestação, a API da Nuvem Fiscal permite listar as notas que ainda não possuem manifestação, ajudando os usuários a identificar rapidamente as notas que necessitam de ação.

O usuário pode optar por listar apenas as notas que não possuem manifestação conclusiva ou que não possuem qualquer tipo de manifestação. Essa flexibilidade permite um controle mais preciso e adequado às necessidades operacionais de cada empresa.

Os documentos são retornados ordenados decrescentemente pela data de distribuição, permitindo uma visualização clara e organizada das notas mais recentes.

Cenários de uso:

  • Identificar rapidamente as notas que ainda precisam de manifestação para obter o XML completo.
  • Listar todas as notas fiscais eletrônicas que foram registradas com ciência da operação, mas ainda não possuem uma manifestação conclusiva (confirmação da operação, desconhecimento da operação ou operação não realizada).
  • Listar todas as notas fiscais eletrônicas que não possuem nenhum tipo de manifestação registrada (nem ciência da operação, nem manifestação conclusiva).
Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.

Utilize o valor sem máscara.

ambiente
required
string

Identificação do Ambiente.

Valores aceitos: homologacao, producao

conclusiva
boolean
Default: false

Indica se serão consideradas apenas as manifestações conclusivas.

Valores:

  • false: serão retornadas notas que não possuírem qualquer tipo de manifestação.

  • true: apenas as notas que não possuírem manifestação conclusiva serão retornadas. Ou seja, notas que tenham sido manifestadas apenas com Ciência da Operação (210210) continuarão sendo retornadas por esse endpoint até que recebam uma manifestação conclusiva.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar distribuição

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único da distribuição de NF-e gerada pela Nuvem Fiscal.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "processando",
  • "ambiente": "homologacao",
  • "uf_autor": "string",
  • "tipo_consulta": "dist-nsu",
  • "dist_nsu": 0,
  • "cons_nsu": 0,
  • "cons_chave": "string",
  • "codigo_status": 0,
  • "motivo_status": "string",
  • "data_hora_resposta": "2019-08-24T14:15:22Z",
  • "ultimo_nsu": 0,
  • "max_nsu": 0,
  • "documentos": [
    ]
}

Email

Listar e-mails

Retorna a lista dos emails associadas à sua conta. Os e-emails são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cpf_cnpj
required
string

Filtra pelo CPF ou CNPJ da empresa.

Utilize o valor sem máscara.

undelivered
boolean

Filtra apenas emails com problemas de entrega.

email
string

Filtra pelo endereço de e-mail do destinatário para qual o email foi enviado.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar e-mail

Obtém informações detalhadas sobre o envio de um email. Este endpoint permite rastrear todos os eventos relacionados ao email, como envio, entrega, falhas e outros eventos relevantes.

Com este endpoint, é possível ter uma visão completa do ciclo de vida de um email enviado, permitindo que os usuários acompanhem e analisem o status e o histórico de eventos do email. Isso é particularmente útil para identificar problemas de entrega e entender o comportamento do email ao longo do tempo.

Authorizations:
jwtoauth2
path Parameters
id
required
string

ID único do e-mail.

Esse parâmetro é obtido após o envio do email por qualquer endpoint da API da Nuvem Fiscal que realize disparos de email.

Exemplos:

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "pending",
  • "sent_at": "2019-08-24T14:15:22Z",
  • "to": [
    ],
  • "cc": [
    ],
  • "reply_to": "string",
  • "subject": "string",
  • "attachments": [
    ],
  • "events": [
    ]
}

Cnpj

Listar estabelecimentos ativos a partir da base de CNPJ

Retorna uma lista de estabelecimentos de acordo com os critérios de busca utilizados. Somente serão retornados estabelecimentos com situação cadastral "Ativa".

Informações adicionais:

  • Cota: cnpj-listagem
  • Consumo: 1 unidade por estabelecimento listado ou requisição.
Authorizations:
jwtoauth2
query Parameters
$top
integer
Default: 10

Limite no número de objetos a serem retornados pela API, entre 1 e 100.

$skip
integer
Default: 0

Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.

$inlinecount
boolean
Default: false

Inclui no JSON de resposta, na propriedade @count, o número total de registros que o filtro retornaria, independente dos filtros de paginação.

cnae_principal
required
string

Filtro pelo código CNAE da atividade principal do estabelecimento. Utilize o valor sem máscara.

municipio
required
string

Filtro pelo código IBGE ou TOM (Tabela de Órgãos e Municípios) do município do estabelecimento. Utilize o valor sem máscara.

natureza_juridica
required
string

Filtro pela natureza jurídica do estabelecimento Utilize o valor de quatro dígitos sem máscara.

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "data": [
    ]
}

Consultar dados do CNPJ

Informações adicionais:

Authorizations:
jwtoauth2
path Parameters
Cnpj
required
string

CNPJ sem máscara.

Responses

Response samples

Content type
application/json
{
  • "cnpj": "string",
  • "razao_social": "string",
  • "nome_fantasia": "string",
  • "data_inicio_atividade": "2019-08-24",
  • "matriz": true,
  • "natureza_juridica": {
    },
  • "capital_social": 0,
  • "porte": {
    },
  • "ente_federativo_responsavel": "string",
  • "situacao_cadastral": {
    },
  • "motivo_situacao_cadastral": {
    },
  • "nome_da_cidade_no_exterior": "string",
  • "pais": {
    },
  • "atividade_principal": {
    },
  • "atividades_secundarias": [
    ],
  • "endereco": {
    },
  • "telefones": [
    ],
  • "email": "string",
  • "situacao_especial": {
    },
  • "simples": {
    },
  • "simei": {
    },
  • "socios": [
    ]
}

Cep

Consultar endereço através do CEP

Informações adicionais:

Authorizations:
jwtoauth2
path Parameters
Cep
required
string

CEP sem máscara.

Responses

Response samples

Content type
application/json
{
  • "bairro": "string",
  • "cep": "string",
  • "codigo_ibge": "string",
  • "complemento": "string",
  • "logradouro": "string",
  • "municipio": "string",
  • "tipo_logradouro": "string",
  • "uf": "string"
}