Pular para o conteúdo principal

API Nuvem Fiscal (2.27.6)

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"
}

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.
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.
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

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

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

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

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

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

Array of objects (NfseDpsPedidoEmissao)

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

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

Identificação do Ambiente.

referencia
string

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

Array of objects (RpsPedidoEmissao)

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

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

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.
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

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

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,
  • "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,
  • "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

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

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

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": {