API Nuvem Fiscal (2.30.0)
Download OpenAPI specification:Download
API para automação comercial e documentos fiscais.
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:
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 |
cpf_cnpj | string Filtrar pelo CPF ou CNPJ da empresa. Utilize o valor sem máscara. |
Responses
Response samples
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
]
}
Cadastrar empresa
Cadastre uma nova empresa (emitente ou prestador) à sua conta.
Authorizations:
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 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 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
- Payload
{- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
Response samples
- 200
{- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
Consultar empresa
Authorizations:
path Parameters
cpf_cnpj required | string CPF ou CNPJ da empresa. Utilize o valor sem máscara. |
Responses
Response samples
- 200
{- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
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:
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 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 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
- Payload
{- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
Response samples
- 200
{- "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": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}
}
Consultar certificado
Authorizations:
path Parameters
cpf_cnpj required | string CPF ou CNPJ da empresa. Utilize o valor sem máscara. |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "certificado": "string",
- "password": "string"
}
Response samples
- 200
{- "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"
}
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 amultipart/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:
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
- 200
{- "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"
}
Alterar configuração de CT-e
Authorizations:
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:
|
ambiente required | string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação. |
Responses
Request samples
- Payload
{- "CRT": 3,
- "ambiente": "homologacao"
}
Response samples
- 200
{- "CRT": 3,
- "ambiente": "homologacao"
}
Enviar logotipo
Cadastre ou atualize um logotipo e vincule a sua empresa.
Restrições:
- Tipos de mídia (MIME) suportados:
image/png
eimage/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:
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
Alterar configuração de MDF-e
Authorizations:
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
- Payload
{- "ambiente": "homologacao"
}
Response samples
- 200
{- "ambiente": "homologacao"
}
Alterar configuração de NFC-e
Authorizations:
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:
|
required | object (EmpresaConfigNfceSefaz) |
ambiente required | string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação. |
Responses
Request samples
- Payload
{- "CRT": 3,
- "sefaz": {
- "id_csc": 0,
- "csc": "string"
}, - "ambiente": "homologacao"
}
Response samples
- 200
{- "CRT": 3,
- "sefaz": {
- "id_csc": 0,
- "csc": "string"
}, - "ambiente": "homologacao"
}
Alterar configuração de NFCom
Authorizations:
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:
|
ambiente required | string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação. |
Responses
Request samples
- Payload
{- "CRT": 3,
- "ambiente": "homologacao"
}
Response samples
- 200
{- "CRT": 3,
- "ambiente": "homologacao"
}
Alterar configuração de NF-e
Authorizations:
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:
|
ambiente required | string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação. |
Responses
Request samples
- Payload
{- "CRT": 3,
- "ambiente": "homologacao"
}
Response samples
- 200
{- "CRT": 3,
- "ambiente": "homologacao"
}
Consultar configuração de NFS-e
Authorizations:
path Parameters
cpf_cnpj required | string CPF ou CNPJ da empresa. Utilize o valor sem máscara. |
Responses
Response samples
- 200
{- "regTrib": {
- "opSimpNac": 1,
- "regApTribSN": 0,
- "regEspTrib": 0
}, - "rps": {
- "lote": 0,
- "serie": "string",
- "numero": 0
}, - "prefeitura": {
- "login": "string",
- "senha": "string",
- "token": "string"
}, - "incentivo_fiscal": false,
- "ambiente": "homologacao"
}
Alterar configuração de NFS-e
Authorizations:
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
- Payload
{- "regTrib": {
- "opSimpNac": 1,
- "regApTribSN": 0,
- "regEspTrib": 0
}, - "rps": {
- "lote": 0,
- "serie": "string",
- "numero": 0
}, - "prefeitura": {
- "login": "string",
- "senha": "string",
- "token": "string"
}, - "incentivo_fiscal": false,
- "ambiente": "homologacao"
}
Response samples
- 200
{- "regTrib": {
- "opSimpNac": 1,
- "regApTribSN": 0,
- "regEspTrib": 0
}, - "rps": {
- "lote": 0,
- "serie": "string",
- "numero": 0
}, - "prefeitura": {
- "login": "string",
- "senha": "string",
- "token": "string"
}, - "incentivo_fiscal": false,
- "ambiente": "homologacao"
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
]
}
Emitir NFS-e Deprecated
Authorizations:
Request Body schema: application/json
ambiente required | string Enum: "homologacao" "producao" Identificação do Ambiente. |
required | object (RpsPedidoEmissao) |
Responses
Request samples
- Payload
{- "ambiente": "homologacao",
- "rps": {
- "referencia": "string",
- "data_emissao": "2019-08-24T14:15:22Z",
- "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string"
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
Response samples
- 200
{- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
Consultar metadados
Consulta a disponibilidade de emissão e alguns metadados de um município.
Authorizations:
path Parameters
codigo_ibge required | string Código IBGE do município. |
Responses
Response samples
- 200
{- "codigo_ibge": "string",
- "uf": "string",
- "municipio": "string",
- "provedor": "string",
- "ambientes": [
- "homologacao"
], - "credenciais": [
- "certificado"
]
}
Emitir NFS-e
Authorizations:
Request Body schema: application/json
provedor | string Enum: "padrao" "nacional" Default: Identificação do provedor para transmissão da DPS:
|
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
- Payload
{- "provedor": "padrao",
- "ambiente": "homologacao",
- "referencia": "string",
- "infDPS": {
- "tpAmb": 0,
- "dhEmi": "2019-08-24T14:15:22Z",
- "verAplic": "string",
- "dCompet": "2019-08-24",
- "subst": {
- "chSubstda": "string",
- "cMotivo": "string",
- "xMotivo": "stringstringstr"
}, - "prest": {
- "CNPJ": "string",
- "CPF": "string"
}, - "toma": {
- "CNPJ": "string",
- "CPF": "string",
- "NIF": "string",
- "cNaoNIF": 0,
- "CAEPF": "string",
- "IM": "string",
- "xNome": "string",
- "end": {
- "endNac": {
- "cMun": "string",
- "CEP": "string"
}, - "endExt": {
- "cPais": "string",
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}, - "fone": "string",
- "email": "string"
}, - "interm": {
- "CNPJ": "string",
- "CPF": "string",
- "NIF": "string",
- "cNaoNIF": 0,
- "CAEPF": "string",
- "IM": "string",
- "xNome": "string",
- "end": {
- "endNac": {
- "cMun": "string",
- "CEP": "string"
}, - "endExt": {
- "cPais": "string",
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}, - "fone": "string",
- "email": "string"
}, - "serv": {
- "locPrest": {
- "cLocPrestacao": "string",
- "cPaisPrestacao": "string"
}, - "cServ": {
- "cTribNac": "string",
- "cTribMun": "string",
- "CNAE": "string",
- "xDescServ": "string",
- "cNBS": "string"
}, - "comExt": {
- "mdPrestacao": 0,
- "vincPrest": 0,
- "tpMoeda": "str",
- "vServMoeda": 0,
- "mecAFComexP": "string",
- "mecAFComexT": "string",
- "movTempBens": 0,
- "nDI": "string",
- "nRE": "string",
- "mdic": 0
}, - "lsadppu": {
- "categ": 0,
- "objeto": 0,
- "extensao": "strin",
- "nPostes": "string"
}, - "obra": {
- "cObra": "string",
- "inscImobFisc": "string",
- "end": {
- "CEP": "string",
- "endExt": {
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}
}, - "atvEvento": {
- "xNome": "string",
- "desc": "string",
- "dtIni": "2019-08-24",
- "dtFim": "2019-08-24",
- "idAtvEvt": "string",
- "id": "string",
- "end": {
- "CEP": "string",
- "endExt": {
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}
}, - "explRod": {
- "categVeic": "string",
- "nEixos": "string",
- "rodagem": 0,
- "sentido": "string",
- "placa": "string",
- "codAcessoPed": "string",
- "codContrato": "string"
}, - "infoCompl": {
- "idDocTec": "string",
- "docRef": "string",
- "xInfComp": "string"
}
}, - "valores": {
- "vServPrest": {
- "vReceb": 0,
- "vServ": 0
}, - "vDescCondIncond": {
- "vDescIncond": 0,
- "vDescCond": 0
}, - "vDedRed": {
- "pDR": 0,
- "vDR": 0,
- "documentos": {
- "docDedRed": [
- {
- "chNFSe": "string",
- "chNFe": "string",
- "NFSeMun": {
- "cMunNFSeMun": "string",
- "nNFSeMun": 0,
- "cVerifNFSeMun": "string"
}, - "NFNFS": {
- "nNFS": 9999999,
- "modNFS": 0,
- "serieNFS": "string"
}, - "nDocFisc": "string",
- "nDoc": "string",
- "tpDedRed": 0,
- "xDescOutDed": "string",
- "dtEmiDoc": "2019-08-24",
- "vDedutivelRedutivel": 0,
- "vDeducaoReducao": 0,
- "fornec": {
- "CNPJ": "string",
- "CPF": "string",
- "NIF": "string",
- "cNaoNIF": 0,
- "CAEPF": "string",
- "IM": "string",
- "xNome": "string",
- "end": {
- "endNac": {
- "cMun": null,
- "CEP": null
}, - "endExt": {
- "cPais": null,
- "cEndPost": null,
- "xCidade": null,
- "xEstProvReg": null
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}, - "fone": "string",
- "email": "string"
}
}
]
}
}, - "trib": {
- "tribMun": {
- "tribISSQN": 0,
- "cLocIncid": "string",
- "cPaisResult": "string",
- "BM": {
- "tpBM": 0,
- "nBM": "string",
- "vRedBCBM": 0,
- "pRedBCBM": 0
}, - "exigSusp": {
- "tpSusp": 0,
- "nProcesso": "string"
}, - "tpImunidade": 0,
- "vBC": 0,
- "pAliq": 0,
- "vISSQN": 0,
- "tpRetISSQN": 1,
- "vLiq": 0
}, - "tribFed": {
- "piscofins": {
- "CST": "string",
- "vBCPisCofins": 0,
- "pAliqPis": 0,
- "pAliqCofins": 0,
- "vPis": 0,
- "vCofins": 0,
- "tpRetPisCofins": 0
}, - "vRetCP": 0,
- "vRetIRRF": 0,
- "vRetCSLL": 0
}, - "totTrib": {
- "vTotTrib": {
- "vTotTribFed": 0,
- "vTotTribEst": 0,
- "vTotTribMun": 0
}, - "pTotTrib": {
- "pTotTribFed": 0,
- "pTotTribEst": 0,
- "pTotTribMun": 0
}, - "indTotTrib": 0,
- "pTotTribSN": 0
}
}
}
}
}
Response samples
- 200
{- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
Emitir lote de NFS-e
Authorizations:
Request Body schema: application/json
provedor | string Enum: "padrao" "nacional" Default: Identificação do provedor para transmissão da DPS:
|
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
- Payload
{- "provedor": "padrao",
- "ambiente": "homologacao",
- "referencia": "string",
- "documentos": [
- {
- "provedor": "padrao",
- "ambiente": "homologacao",
- "referencia": "string",
- "infDPS": {
- "tpAmb": 0,
- "dhEmi": "2019-08-24T14:15:22Z",
- "verAplic": "string",
- "dCompet": "2019-08-24",
- "subst": {
- "chSubstda": "string",
- "cMotivo": "string",
- "xMotivo": "stringstringstr"
}, - "prest": {
- "CNPJ": "string",
- "CPF": "string"
}, - "toma": {
- "CNPJ": "string",
- "CPF": "string",
- "NIF": "string",
- "cNaoNIF": 0,
- "CAEPF": "string",
- "IM": "string",
- "xNome": "string",
- "end": {
- "endNac": {
- "cMun": "string",
- "CEP": "string"
}, - "endExt": {
- "cPais": "string",
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}, - "fone": "string",
- "email": "string"
}, - "interm": {
- "CNPJ": "string",
- "CPF": "string",
- "NIF": "string",
- "cNaoNIF": 0,
- "CAEPF": "string",
- "IM": "string",
- "xNome": "string",
- "end": {
- "endNac": {
- "cMun": "string",
- "CEP": "string"
}, - "endExt": {
- "cPais": "string",
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}, - "fone": "string",
- "email": "string"
}, - "serv": {
- "locPrest": {
- "cLocPrestacao": "string",
- "cPaisPrestacao": "string"
}, - "cServ": {
- "cTribNac": "string",
- "cTribMun": "string",
- "CNAE": "string",
- "xDescServ": "string",
- "cNBS": "string"
}, - "comExt": {
- "mdPrestacao": 0,
- "vincPrest": 0,
- "tpMoeda": "str",
- "vServMoeda": 0,
- "mecAFComexP": "string",
- "mecAFComexT": "string",
- "movTempBens": 0,
- "nDI": "string",
- "nRE": "string",
- "mdic": 0
}, - "lsadppu": {
- "categ": 0,
- "objeto": 0,
- "extensao": "strin",
- "nPostes": "string"
}, - "obra": {
- "cObra": "string",
- "inscImobFisc": "string",
- "end": {
- "CEP": "string",
- "endExt": {
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}
}, - "atvEvento": {
- "xNome": "string",
- "desc": "string",
- "dtIni": "2019-08-24",
- "dtFim": "2019-08-24",
- "idAtvEvt": "string",
- "id": "string",
- "end": {
- "CEP": "string",
- "endExt": {
- "cEndPost": "string",
- "xCidade": "string",
- "xEstProvReg": "string"
}, - "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string"
}
}, - "explRod": {
- "categVeic": "string",
- "nEixos": "string",
- "rodagem": 0,
- "sentido": "string",
- "placa": "string",
- "codAcessoPed": "string",
- "codContrato": "string"
}, - "infoCompl": {
- "idDocTec": "string",
- "docRef": "string",
- "xInfComp": "string"
}
}, - "valores": {
- "vServPrest": {
- "vReceb": 0,
- "vServ": 0
}, - "vDescCondIncond": {
- "vDescIncond": 0,
- "vDescCond": 0
}, - "vDedRed": {
- "pDR": 0,
- "vDR": 0,
- "documentos": {
- "docDedRed": [
- {
- "chNFSe": "string",
- "chNFe": "string",
- "NFSeMun": {
- "cMunNFSeMun": null,
- "nNFSeMun": null,
- "cVerifNFSeMun": null
}, - "NFNFS": {
- "nNFS": null,
- "modNFS": null,
- "serieNFS": null
}, - "nDocFisc": "string",
- "nDoc": "string",
- "tpDedRed": 0,
- "xDescOutDed": "string",
- "dtEmiDoc": "2019-08-24",
- "vDedutivelRedutivel": 0,
- "vDeducaoReducao": 0,
- "fornec": {
- "CNPJ": null,
- "CPF": null,
- "NIF": null,
- "cNaoNIF": null,
- "CAEPF": null,
- "IM": null,
- "xNome": null,
- "end": null,
- "fone": null,
- "email": null
}
}
]
}
}, - "trib": {
- "tribMun": {
- "tribISSQN": 0,
- "cLocIncid": "string",
- "cPaisResult": "string",
- "BM": {
- "tpBM": 0,
- "nBM": "string",
- "vRedBCBM": 0,
- "pRedBCBM": 0
}, - "exigSusp": {
- "tpSusp": 0,
- "nProcesso": "string"
}, - "tpImunidade": 0,
- "vBC": 0,
- "pAliq": 0,
- "vISSQN": 0,
- "tpRetISSQN": 1,
- "vLiq": 0
}, - "tribFed": {
- "piscofins": {
- "CST": "string",
- "vBCPisCofins": 0,
- "pAliqPis": 0,
- "pAliqCofins": 0,
- "vPis": 0,
- "vCofins": 0,
- "tpRetPisCofins": 0
}, - "vRetCP": 0,
- "vRetIRRF": 0,
- "vRetCSLL": 0
}, - "totTrib": {
- "vTotTrib": {
- "vTotTribFed": 0,
- "vTotTribEst": 0,
- "vTotTribMun": 0
}, - "pTotTrib": {
- "pTotTribFed": 0,
- "pTotTribEst": 0,
- "pTotTribMun": 0
}, - "indTotTrib": 0,
- "pTotTribSN": 0
}
}
}
}
}
]
}
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "novo",
- "numero": "string",
- "ambiente": "homologacao",
- "referencia": "string",
- "notas": [
- {
- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
]
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "novo",
- "numero": "string",
- "ambiente": "homologacao",
- "referencia": "string",
- "notas": [
- {
- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
]
}
]
}
Emitir lote de NFS-e Deprecated
Authorizations:
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
- Payload
{- "ambiente": "homologacao",
- "referencia": "string",
- "lista_rps": [
- {
- "referencia": "string",
- "data_emissao": "2019-08-24T14:15:22Z",
- "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string"
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
]
}
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "novo",
- "numero": "string",
- "ambiente": "homologacao",
- "referencia": "string",
- "notas": [
- {
- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
]
}
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:
path Parameters
id required | string ID único do lote gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "novo",
- "numero": "string",
- "ambiente": "homologacao",
- "referencia": "string",
- "notas": [
- {
- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
]
}
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:
path Parameters
id required | string ID único da NFS-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "serie": "string",
- "nDPS": "string"
}, - "cancelamento": {
- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}, - "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
], - "declaracao_prestacao_servico": {
- "rps": {
- "identificacao_rps": {
- "numero": "string",
- "serie": "string",
- "tipo": "string"
}, - "data_emissao": "2019-08-24T14:15:22Z"
}, - "competencia": "2019-08-24T14:15:22Z",
- "natureza_tributacao": 0,
- "prestador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "nome_fantasia": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "Brasil",
- "cep": "string"
}, - "optante_simples_nacional": true,
- "regime_tributacao": 0,
- "regime_especial_tributacao": 0,
- "incentivo_fiscal": true,
- "incentivador_cultural": true
}, - "tomador": {
- "cpf_cnpj": "string",
- "inscricao_municipal": "string",
- "nome_razao_social": "string",
- "fone": "string",
- "email": "string",
- "endereco": {
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "codigo_municipio": "string",
- "cidade": "string",
- "uf": "string",
- "codigo_pais": "1058",
- "pais": "string",
- "cep": "string"
}
}, - "intermediario": {
- "cpf_cnpj": "string",
- "nome_razao_social": "string",
- "inscricao_municipal": "string"
}, - "construcao_civil": {
- "codigo_obra": "string",
- "art": "string"
}, - "servicos": [
- {
- "iss_retido": false,
- "responsavel_retencao": 0,
- "item_lista_servico": "string",
- "codigo_cnae": "string",
- "codigo_tributacao_municipio": "string",
- "discriminacao": "string",
- "codigo_municipio": "string",
- "codigo_pais": "string",
- "tipo_tributacao": 6,
- "exigibilidade_iss": 1,
- "codigo_municipio_incidencia": "string",
- "numero_processo": "string",
- "unidade": "string",
- "quantidade": 1,
- "valores": {
- "valor_unitario": 0,
- "valor_servicos": 0,
- "valor_deducoes": 0,
- "valor_pis": 0,
- "valor_cofins": 0,
- "valor_inss": 0,
- "valor_ir": 0,
- "valor_csll": 0,
- "valor_outras_retencoes": 0,
- "valor_iss": 0,
- "valor_iss_retido": 0,
- "valor_liquido": 0,
- "aliquota_iss": 0,
- "aliquota_pis": 0,
- "aliquota_cofins": 0,
- "aliquota_inss": 0,
- "aliquota_ir": 0,
- "aliquota_csll": 0,
- "desconto_incondicionado": 0,
- "desconto_condicionado": 0
}
}
], - "outras_informacoes": "string"
}
}
Consultar o cancelamento da NFS-e
Authorizations:
path Parameters
id required | string ID único da NFS-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}
Cancelar uma NFS-e autorizada
Authorizations:
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
- Payload
{- "codigo": "string",
- "motivo": "string"
}
Response samples
- 200
{- "id": "string",
- "status": "pendente",
- "codigo": "string",
- "motivo": "string",
- "data_hora": "2019-08-24T14:15:22Z",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}
Baixar PDF do DANFSE
Authorizations:
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 Exemplos de Uso:
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
autorizada
na Nuvem Fiscal, mas está cancelada na prefeitura.
Authorizations:
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
- Payload
{- "identificador": "string"
}
Response samples
- 200
{- "status": "pendente",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "correcao": "string"
}
]
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Emitir NFCom
Authorizations:
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
- Payload
{- "infNFCom": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "tpAmb": 0,
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "cNF": "string",
- "cDV": 9,
- "dhEmi": "2019-08-24T14:15:22Z",
- "tpEmis": 0,
- "nSiteAutoriz": 9,
- "cMunFG": "string",
- "finNFCom": 0,
- "tpFat": 0,
- "verProc": "string",
- "indPrePago": 0,
- "indCessaoMeiosRede": 0,
- "indNotaEntrada": 0,
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr"
}, - "emit": {
- "CNPJ": "string",
- "IE": "string",
- "IEUFDest": "string",
- "CRT": 0,
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "fone": "string",
- "email": "string"
}
}, - "dest": {
- "xNome": "string",
- "CNPJ": "string",
- "CPF": "string",
- "idOutros": "string",
- "indIEDest": 0,
- "IE": "string",
- "IM": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string"
}
}, - "assinante": {
- "iCodAssinante": "string",
- "tpAssinante": 0,
- "tpServUtil": 0,
- "nContrato": "string",
- "dContratoIni": "2019-08-24",
- "dContratoFim": "2019-08-24",
- "NroTermPrinc": "string",
- "cUFPrinc": 0,
- "NroTermAdic": "string",
- "cUFAdic": 0
}, - "gSub": {
- "chNFCom": "string",
- "gNF": {
- "CNPJ": "string",
- "mod": 0,
- "serie": "str",
- "nNF": 1,
- "CompetEmis": "string",
- "hash115": "stringstringstringstringstringst"
}, - "motSub": "st"
}, - "gCofat": {
- "chNFComLocal": "string"
}, - "det": [
- {
- "nItem": 1,
- "chNFComAnt": "string",
- "nItemAnt": "string",
- "prod": {
- "cProd": "string",
- "xProd": "string",
- "cClass": "strings",
- "CFOP": "string",
- "CNPJLD": "string",
- "uMed": 0,
- "qFaturada": 0,
- "vItem": 0,
- "vDesc": 0,
- "vOutro": 0,
- "vProd": 0,
- "dExpiracao": "2019-08-24",
- "indDevolucao": 0
}, - "imposto": {
- "ICMS00": {
- "CST": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS20": {
- "CST": "string",
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "cBenef": "string",
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS40": {
- "CST": "string",
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMS51": {
- "CST": "string",
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMS90": {
- "CST": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "cBenef": "string",
- "pFCP": 0,
- "vFCP": 0
}, - "ICMSSN": {
- "CST": "string",
- "indSN": 0
}, - "ICMSUFDest": [
- {
- "cUFDest": 0,
- "vBCUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFEmi": 0,
- "cBenefUFDest": "string"
}
], - "indSemCST": 0,
- "PIS": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "COFINS": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "FUST": {
- "vBC": 0,
- "pFUST": 0,
- "vFUST": 0
}, - "FUNTTEL": {
- "vBC": 0,
- "pFUNTTEL": 0,
- "vFUNTTEL": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCofins": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0
}
}, - "gProcRef": {
- "vItem": 0,
- "qFaturada": 0,
- "vProd": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indDevolucao": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vFCP": 0,
- "gProc": [
- {
- "tpProc": 0,
- "nProcesso": "string"
}
]
}, - "gRessarc": {
- "tpRessarc": 0,
- "dRef": "2019-08-24",
- "nProcesso": "string",
- "nProtReclama": "string",
- "xObs": "stringstringstr"
}, - "infAdProd": "string"
}
], - "total": {
- "vProd": 0,
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCP": 0
}, - "vCOFINS": 0,
- "vPIS": 0,
- "vFUNTTEL": 0,
- "vFUST": 0,
- "vRetTribTot": {
- "vRetPIS": 0,
- "vRetCofins": 0,
- "vRetCSLL": 0,
- "vIRRF": 0
}, - "vDesc": 0,
- "vOutro": 0,
- "vNF": 0
}, - "gFidelidade": {
- "qtdSaldoPts": "string",
- "dRefSaldoPts": "2019-08-24",
- "qtdPtsResg": "string",
- "dRefResgPts": "2019-08-24"
}, - "gFat": {
- "CompetFat": "string",
- "dVencFat": "2019-08-24",
- "dPerUsoIni": "2019-08-24",
- "dPerUsoFim": "2019-08-24",
- "codBarras": "string",
- "codDebAuto": "string",
- "codBanco": "strin",
- "codAgencia": "string",
- "enderCorresp": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "fone": "string",
- "email": "string"
}, - "gPIX": {
- "urlQRCodePIX": "string"
}
}, - "gFatCentral": {
- "CNPJ": "string",
- "cUF": 0
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "infAdic": {
- "infAdFisco": "string",
- "infCpl": [
- "string"
]
}, - "gRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 999,
- "hashCSRT": "string"
}
}, - "ambiente": "homologacao",
- "referencia": "string"
}
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
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:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
autorizador | string Ambiente Autorizador. Autorizadores disponíveis: Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único da NFCom gerada pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 o cancelamento da NFCom
Authorizations:
path Parameters
id required | string ID único da NFCom gerada pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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:
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
- Payload
{- "justificativa": "string"
}
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 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:
path Parameters
id required | string ID único da NFCom gerada pela Nuvem Fiscal. |
Responses
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Emitir CT-e
Authorizations:
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
- Payload
{- "infCte": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cCT": "string",
- "CFOP": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nCT": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "tpCTe": 0,
- "procEmi": 0,
- "verProc": "string",
- "indGlobalizado": 0,
- "cMunEnv": "string",
- "xMunEnv": "string",
- "UFEnv": "string",
- "modal": "string",
- "tpServ": 0,
- "cMunIni": "string",
- "xMunIni": "string",
- "UFIni": "string",
- "cMunFim": "string",
- "xMunFim": "string",
- "UFFim": "string",
- "retira": 0,
- "xDetRetira": "string",
- "indIEToma": 0,
- "toma3": {
- "toma": 0
}, - "toma4": {
- "toma": 0,
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "xFant": "string",
- "fone": "string",
- "enderToma": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string"
}, - "email": "string"
}, - "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr"
}, - "compl": {
- "xCaracAd": "string",
- "xCaracSer": "string",
- "xEmi": "string",
- "fluxo": {
- "xOrig": "string",
- "pass": [
- {
- "xPass": "string"
}
], - "xDest": "string",
- "xRota": "string"
}, - "Entrega": {
- "semData": {
- "tpPer": 0
}, - "comData": {
- "tpPer": 0,
- "dProg": "2019-08-24"
}, - "noPeriodo": {
- "tpPer": 0,
- "dIni": "2019-08-24",
- "dFim": "2019-08-24"
}, - "semHora": {
- "tpHor": 0
}, - "comHora": {
- "tpHor": 0,
- "hProg": "string"
}, - "noInter": {
- "tpHor": 0,
- "hIni": "string",
- "hFim": "string"
}
}, - "origCalc": "string",
- "destCalc": "string",
- "xObs": "string",
- "ObsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "ObsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "IEST": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "fone": "string"
}, - "CRT": 0
}, - "rem": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "xFant": "string",
- "fone": "string",
- "enderReme": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string"
}, - "email": "string"
}, - "exped": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "fone": "string",
- "enderExped": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string"
}, - "email": "string"
}, - "receb": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "fone": "string",
- "enderReceb": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string"
}, - "email": "string"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "fone": "string",
- "ISUF": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "cPais": "string",
- "xPais": "string"
}, - "email": "string"
}, - "vPrest": {
- "vTPrest": 0,
- "vRec": 0,
- "Comp": [
- {
- "xNome": "string",
- "vComp": 0
}
]
}, - "imp": {
- "ICMS": {
- "ICMS00": {
- "CST": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0
}, - "ICMS20": {
- "CST": "string",
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMS45": {
- "CST": "string",
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMS60": {
- "CST": "string",
- "vBCSTRet": 0,
- "vICMSSTRet": 0,
- "pICMSSTRet": 0,
- "vCred": 0,
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMS90": {
- "CST": "string",
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vCred": 0,
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMSOutraUF": {
- "CST": "string",
- "pRedBCOutraUF": 0,
- "vBCOutraUF": 0,
- "pICMSOutraUF": 0,
- "vICMSOutraUF": 0,
- "vICMSDeson": 0,
- "cBenef": "string"
}, - "ICMSSN": {
- "CST": "string",
- "indSN": 0
}
}, - "vTotTrib": 0,
- "infAdFisco": "string",
- "ICMSUFFim": {
- "vBCUFFim": 0,
- "pFCPUFFim": 0,
- "pICMSUFFim": 0,
- "pICMSInter": 0,
- "vFCPUFFim": 0,
- "vICMSUFFim": 0,
- "vICMSUFIni": 0
}
}, - "infCTeNorm": {
- "infCarga": {
- "vCarga": 0,
- "proPred": "string",
- "xOutCat": "string",
- "infQ": [
- {
- "cUnid": "string",
- "tpMed": "string",
- "qCarga": 0
}
], - "vCargaAverb": 0
}, - "infDoc": {
- "infNF": [
- {
- "nRoma": "string",
- "nPed": "string",
- "mod": "string",
- "serie": "str",
- "nDoc": "string",
- "dEmi": "2019-08-24",
- "vBC": 0,
- "vICMS": 0,
- "vBCST": 0,
- "vST": 0,
- "vProd": 0,
- "vNF": 0,
- "nCFOP": "string",
- "nPeso": 0,
- "PIN": "string",
- "dPrev": "2019-08-24",
- "infUnidCarga": [
- {
- "tpUnidCarga": 0,
- "idUnidCarga": "string",
- "lacUnidCarga": [
- {
- "nLacre": null
}
], - "qtdRat": 0
}
], - "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- {
- "nLacre": null
}
], - "infUnidCarga": [
- {
- "tpUnidCarga": null,
- "idUnidCarga": null,
- "lacUnidCarga": [ ],
- "qtdRat": null
}
], - "qtdRat": 0
}
]
}
], - "infNFe": [
- {
- "chave": "string",
- "PIN": "string",
- "dPrev": "2019-08-24",
- "infUnidCarga": [
- {
- "tpUnidCarga": 0,
- "idUnidCarga": "string",
- "lacUnidCarga": [
- {
- "nLacre": null
}
], - "qtdRat": 0
}
], - "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- {
- "nLacre": null
}
], - "infUnidCarga": [
- {
- "tpUnidCarga": null,
- "idUnidCarga": null,
- "lacUnidCarga": [ ],
- "qtdRat": null
}
], - "qtdRat": 0
}
]
}
], - "infOutros": [
- {
- "tpDoc": "string",
- "descOutros": "string",
- "nDoc": "string",
- "dEmi": "2019-08-24",
- "vDocFisc": 0,
- "dPrev": "2019-08-24",
- "infUnidCarga": [
- {
- "tpUnidCarga": 0,
- "idUnidCarga": "string",
- "lacUnidCarga": [
- {
- "nLacre": null
}
], - "qtdRat": 0
}
], - "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- {
- "nLacre": null
}
], - "infUnidCarga": [
- {
- "tpUnidCarga": null,
- "idUnidCarga": null,
- "lacUnidCarga": [ ],
- "qtdRat": null
}
], - "qtdRat": 0
}
]
}
]
}, - "docAnt": {
- "emiDocAnt": [
- {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "UF": "string",
- "xNome": "string",
- "idDocAnt": [
- {
- "idDocAntPap": [
- {
- "tpDoc": null,
- "serie": null,
- "subser": null,
- "nDoc": null,
- "dEmi": null
}
], - "idDocAntEle": [
- {
- "chCTe": null
}
]
}
]
}
]
}, - "infModal": {
- "versaoModal": "string",
- "rodo": {
- "RNTRC": "string",
- "occ": [
- {
- "serie": "str",
- "nOcc": 1,
- "dEmi": "2019-08-24",
- "emiOcc": {
- "CNPJ": "string",
- "cInt": "string",
- "IE": "string",
- "UF": "string",
- "fone": "string"
}
}
]
}, - "aereo": {
- "nMinu": 999999999,
- "nOCA": "string",
- "dPrevAereo": "2019-08-24",
- "natCarga": {
- "xDime": "string",
- "cInfManu": [
- "string"
]
}, - "tarifa": {
- "CL": "s",
- "cTar": "stri",
- "vTar": 0
}, - "peri": [
- {
- "nONU": "string",
- "qTotEmb": "string",
- "infTotAP": {
- "qTotProd": 0,
- "uniAP": 0
}
}
]
}, - "ferrov": {
- "tpTraf": 0,
- "trafMut": {
- "respFat": 0,
- "ferrEmi": 0,
- "vFrete": 0,
- "chCTeFerroOrigem": "string",
- "ferroEnv": [
- {
- "CNPJ": "string",
- "cInt": "string",
- "IE": "string",
- "xNome": "string",
- "enderFerro": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string"
}
}
]
}, - "fluxo": "string"
}, - "aquav": {
- "vPrest": 0,
- "vAFRMM": 0,
- "xNavio": "string",
- "balsa": [
- {
- "xBalsa": "string"
}
], - "nViag": "string",
- "direc": "string",
- "irin": "string",
- "detCont": [
- {
- "nCont": "string",
- "lacre": [
- {
- "nLacre": "string"
}
], - "infDoc": {
- "infNF": [
- {
- "serie": null,
- "nDoc": null,
- "unidRat": null
}
], - "infNFe": [
- {
- "chave": null,
- "unidRat": null
}
]
}
}
], - "tpNav": 0
}, - "duto": {
- "vTar": 0,
- "dIni": "2019-08-24",
- "dFim": "2019-08-24"
}, - "multimodal": {
- "COTM": "string",
- "indNegociavel": 0,
- "seg": {
- "infSeg": {
- "xSeg": "string",
- "CNPJ": "string"
}, - "nApol": "string",
- "nAver": "string"
}
}
}, - "veicNovos": [
- {
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "cMod": "string",
- "vUnit": 0,
- "vFrete": 0
}
], - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "infCteSub": {
- "chCte": "string",
- "indAlteraToma": 0
}, - "infGlobalizado": {
- "xObs": "stringstringstr"
}, - "infServVinc": {
- "infCTeMultimodal": [
- {
- "chCTeMultimodal": "string"
}
]
}
}, - "infCteComp": [
- {
- "chCTe": "string"
}
], - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 999,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infCTeSupl": {
- "qrCodCTe": "stringstringstringstringstringstringstringstringst"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 evento
Authorizations:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
autorizador | string Ambiente Autorizador. Autorizadores disponíveis: Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 o cancelamento do CT-e
Authorizations:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "justificativa": "string"
}
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 solicitação de correção do CT-e
Authorizations:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "correcoes": [
- {
- "grupo_alterado": "string",
- "campo_alterado": "string",
- "valor_alterado": "string",
- "numero_item_alterado": 0
}
], - "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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.
Authorizations:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Request Body schema: application/json
required | Array of objects (CteInfCorrecao) Grupo de Informações de Correção. | ||||||||
Array
|
Responses
Request samples
- Payload
{- "correcoes": [
- {
- "grupo_alterado": "string",
- "campo_alterado": "string",
- "valor_alterado": "string",
- "numero_item_alterado": 0
}
]
}
Response samples
- 200
{- "correcoes": [
- {
- "grupo_alterado": "string",
- "campo_alterado": "string",
- "valor_alterado": "string",
- "numero_item_alterado": 0
}
], - "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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
autorizado
na 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.
Authorizations:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único do CT-e gerado pela Nuvem Fiscal. |
Responses
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Emitir MDF-e
Authorizations:
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infMDFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "tpAmb": 0,
- "tpEmit": 0,
- "tpTransp": 0,
- "mod": 0,
- "serie": 999,
- "nMDF": 1,
- "cMDF": "string",
- "cDV": 9,
- "modal": 0,
- "dhEmi": "2019-08-24T14:15:22Z",
- "tpEmis": 0,
- "procEmi": "string",
- "verProc": "string",
- "UFIni": "string",
- "UFFim": "string",
- "infMunCarrega": [
- {
- "cMunCarrega": "string",
- "xMunCarrega": "string"
}
], - "infPercurso": [
- {
- "UFPer": "string"
}
], - "dhIniViagem": "2019-08-24T14:15:22Z",
- "indCanalVerde": 0,
- "indCarregaPosterior": 0
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "fone": "string",
- "email": "string"
}
}, - "infModal": {
- "versaoModal": "string",
- "aereo": {
- "nac": "stri",
- "matr": "string",
- "nVoo": "string",
- "cAerEmb": "stri",
- "cAerDes": "stri",
- "dVoo": "2019-08-24"
}, - "rodo": {
- "infANTT": {
- "RNTRC": "string",
- "infCIOT": [
- {
- "CIOT": "string",
- "CPF": "string",
- "CNPJ": "string"
}
], - "valePed": {
- "disp": [
- {
- "CNPJForn": "string",
- "CNPJPg": "string",
- "CPFPg": "string",
- "nCompra": "string",
- "vValePed": 0,
- "tpValePed": "string"
}
], - "categCombVeic": "string"
}, - "infContratante": [
- {
- "xNome": "string",
- "CPF": "string",
- "CNPJ": "string",
- "idEstrangeiro": "string",
- "infContrato": {
- "NroContrato": "string",
- "vContratoGlobal": 0
}
}
], - "infPag": [
- {
- "xNome": "string",
- "CPF": "string",
- "CNPJ": "string",
- "idEstrangeiro": "string",
- "Comp": [
- {
- "tpComp": "string",
- "vComp": 0,
- "xComp": "string"
}
], - "vContrato": 0,
- "indAltoDesemp": 0,
- "indPag": 0,
- "vAdiant": 0,
- "indAntecipaAdiant": 0,
- "infPrazo": [
- {
- "nParcela": 999,
- "dVenc": "2019-08-24",
- "vParcela": 0
}
], - "tpAntecip": 0,
- "infBanc": {
- "codBanco": "strin",
- "codAgencia": "string",
- "CNPJIPEF": "string",
- "PIX": "string"
}
}
]
}, - "veicTracao": {
- "cInt": "string",
- "placa": "string",
- "RENAVAM": "stringstr",
- "tara": 999999,
- "capKG": 999999,
- "capM3": 999,
- "prop": {
- "CPF": "string",
- "CNPJ": "string",
- "RNTRC": "string",
- "xNome": "string",
- "IE": "string",
- "UF": "string",
- "tpProp": 0
}, - "condutor": [
- {
- "xNome": "string",
- "CPF": "string"
}
], - "tpRod": "string",
- "tpCar": "string",
- "UF": "string"
}, - "veicReboque": [
- {
- "cInt": "string",
- "placa": "string",
- "RENAVAM": "stringstr",
- "tara": 999999,
- "capKG": 999999,
- "capM3": 999,
- "prop": {
- "CPF": "string",
- "CNPJ": "string",
- "RNTRC": "string",
- "xNome": "string",
- "IE": "string",
- "UF": "string",
- "tpProp": 0
}, - "tpCar": "string",
- "UF": "string"
}
], - "codAgPorto": "string",
- "lacRodo": [
- {
- "nLacre": "string"
}
]
}, - "aquav": {
- "irin": "string",
- "tpEmb": "string",
- "cEmbar": "string",
- "xEmbar": "string",
- "nViag": "string",
- "cPrtEmb": "strin",
- "cPrtDest": "strin",
- "prtTrans": "string",
- "tpNav": 0,
- "infTermCarreg": [
- {
- "cTermCarreg": "string",
- "xTermCarreg": "string"
}
], - "infTermDescarreg": [
- {
- "cTermDescarreg": "string",
- "xTermDescarreg": "string"
}
], - "infEmbComb": [
- {
- "cEmbComb": "string",
- "xBalsa": "string"
}
], - "infUnidCargaVazia": [
- {
- "idUnidCargaVazia": "string",
- "tpUnidCargaVazia": 0
}
], - "infUnidTranspVazia": [
- {
- "idUnidTranspVazia": "string",
- "tpUnidTranspVazia": 0
}
]
}, - "ferrov": {
- "trem": {
- "xPref": "string",
- "dhTrem": "2019-08-24T14:15:22Z",
- "xOri": "str",
- "xDest": "str",
- "qVag": 1
}, - "vag": [
- {
- "pesoBC": 0,
- "pesoR": 0,
- "tpVag": "str",
- "serie": "str",
- "nVag": 1,
- "nSeq": 1,
- "TU": 0
}
]
}
}, - "infDoc": {
- "infMunDescarga": [
- {
- "cMunDescarga": "string",
- "xMunDescarga": "string",
- "infCTe": [
- {
- "chCTe": "string",
- "SegCodBarra": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- null
], - "infUnidCarga": [
- null
], - "qtdRat": 0
}
], - "peri": [
- {
- "nONU": "string",
- "xNomeAE": "string",
- "xClaRisco": "string",
- "grEmb": "string",
- "qTotProd": "string",
- "qVolTipo": "string"
}
], - "infEntregaParcial": {
- "qtdTotal": 0,
- "qtdParcial": 0
}
}
], - "infNFe": [
- {
- "chNFe": "string",
- "SegCodBarra": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- null
], - "infUnidCarga": [
- null
], - "qtdRat": 0
}
], - "peri": [
- {
- "nONU": "string",
- "xNomeAE": "string",
- "xClaRisco": "string",
- "grEmb": "string",
- "qTotProd": "string",
- "qVolTipo": "string"
}
]
}
], - "infMDFeTransp": [
- {
- "chMDFe": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- {
- "tpUnidTransp": 0,
- "idUnidTransp": "string",
- "lacUnidTransp": [
- null
], - "infUnidCarga": [
- null
], - "qtdRat": 0
}
], - "peri": [
- {
- "nONU": "string",
- "xNomeAE": "string",
- "xClaRisco": "string",
- "grEmb": "string",
- "qTotProd": "string",
- "qVolTipo": "string"
}
]
}
]
}
]
}, - "seg": [
- {
- "infResp": {
- "respSeg": 0,
- "CNPJ": "string",
- "CPF": "string"
}, - "infSeg": {
- "xSeg": "string",
- "CNPJ": "string"
}, - "nApol": "string",
- "nAver": [
- "string"
]
}
], - "prodPred": {
- "tpCarga": "string",
- "xProd": "string",
- "cEAN": "string",
- "NCM": "string",
- "infLotacao": {
- "infLocalCarrega": {
- "CEP": "string",
- "latitude": "string",
- "longitude": "string"
}, - "infLocalDescarrega": {
- "CEP": "string",
- "latitude": "string",
- "longitude": "string"
}
}
}, - "tot": {
- "qCTe": 999999,
- "qNFe": 999999,
- "qMDFe": 999999,
- "vCarga": 0,
- "cUnid": "string",
- "qCarga": 0
}, - "lacres": [
- {
- "nLacre": "string"
}
], - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string"
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 999,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infMDFeSupl": {
- "qrCodMDFe": "stringstringstringstringstringstringstringstringst"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 evento do MDF-e
Authorizations:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
]
}
Emitir lote de MDF-e
Authorizations:
Request Body schema: application/json
Array of objects (MdfePedidoEmissao) | |
ambiente required | string Enum: "homologacao" "producao" Identificação do Ambiente. |
referencia | string Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
id_lote required | string |
Responses
Request samples
- Payload
{- "documentos": [
- {
- "infMDFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "tpAmb": 0,
- "tpEmit": 0,
- "tpTransp": 0,
- "mod": 0,
- "serie": 999,
- "nMDF": 1,
- "cMDF": "string",
- "cDV": 9,
- "modal": 0,
- "dhEmi": "2019-08-24T14:15:22Z",
- "tpEmis": 0,
- "procEmi": "string",
- "verProc": "string",
- "UFIni": "string",
- "UFFim": "string",
- "infMunCarrega": [
- {
- "cMunCarrega": "string",
- "xMunCarrega": "string"
}
], - "infPercurso": [
- {
- "UFPer": "string"
}
], - "dhIniViagem": "2019-08-24T14:15:22Z",
- "indCanalVerde": 0,
- "indCarregaPosterior": 0
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "CEP": "string",
- "UF": "string",
- "fone": "string",
- "email": "string"
}
}, - "infModal": {
- "versaoModal": "string",
- "aereo": {
- "nac": "stri",
- "matr": "string",
- "nVoo": "string",
- "cAerEmb": "stri",
- "cAerDes": "stri",
- "dVoo": "2019-08-24"
}, - "rodo": {
- "infANTT": {
- "RNTRC": "string",
- "infCIOT": [
- {
- "CIOT": "string",
- "CPF": "string",
- "CNPJ": "string"
}
], - "valePed": {
- "disp": [
- {
- "CNPJForn": null,
- "CNPJPg": null,
- "CPFPg": null,
- "nCompra": null,
- "vValePed": null,
- "tpValePed": null
}
], - "categCombVeic": "string"
}, - "infContratante": [
- {
- "xNome": "string",
- "CPF": "string",
- "CNPJ": "string",
- "idEstrangeiro": "string",
- "infContrato": {
- "NroContrato": null,
- "vContratoGlobal": null
}
}
], - "infPag": [
- {
- "xNome": "string",
- "CPF": "string",
- "CNPJ": "string",
- "idEstrangeiro": "string",
- "Comp": [
- null
], - "vContrato": 0,
- "indAltoDesemp": 0,
- "indPag": 0,
- "vAdiant": 0,
- "indAntecipaAdiant": 0,
- "infPrazo": [
- null
], - "tpAntecip": 0,
- "infBanc": {
- "codBanco": null,
- "codAgencia": null,
- "CNPJIPEF": null,
- "PIX": null
}
}
]
}, - "veicTracao": {
- "cInt": "string",
- "placa": "string",
- "RENAVAM": "stringstr",
- "tara": 999999,
- "capKG": 999999,
- "capM3": 999,
- "prop": {
- "CPF": "string",
- "CNPJ": "string",
- "RNTRC": "string",
- "xNome": "string",
- "IE": "string",
- "UF": "string",
- "tpProp": 0
}, - "condutor": [
- {
- "xNome": "string",
- "CPF": "string"
}
], - "tpRod": "string",
- "tpCar": "string",
- "UF": "string"
}, - "veicReboque": [
- {
- "cInt": "string",
- "placa": "string",
- "RENAVAM": "stringstr",
- "tara": 999999,
- "capKG": 999999,
- "capM3": 999,
- "prop": {
- "CPF": "string",
- "CNPJ": "string",
- "RNTRC": "string",
- "xNome": "string",
- "IE": "string",
- "UF": "string",
- "tpProp": 0
}, - "tpCar": "string",
- "UF": "string"
}
], - "codAgPorto": "string",
- "lacRodo": [
- {
- "nLacre": "string"
}
]
}, - "aquav": {
- "irin": "string",
- "tpEmb": "string",
- "cEmbar": "string",
- "xEmbar": "string",
- "nViag": "string",
- "cPrtEmb": "strin",
- "cPrtDest": "strin",
- "prtTrans": "string",
- "tpNav": 0,
- "infTermCarreg": [
- {
- "cTermCarreg": "string",
- "xTermCarreg": "string"
}
], - "infTermDescarreg": [
- {
- "cTermDescarreg": "string",
- "xTermDescarreg": "string"
}
], - "infEmbComb": [
- {
- "cEmbComb": "string",
- "xBalsa": "string"
}
], - "infUnidCargaVazia": [
- {
- "idUnidCargaVazia": "string",
- "tpUnidCargaVazia": 0
}
], - "infUnidTranspVazia": [
- {
- "idUnidTranspVazia": "string",
- "tpUnidTranspVazia": 0
}
]
}, - "ferrov": {
- "trem": {
- "xPref": "string",
- "dhTrem": "2019-08-24T14:15:22Z",
- "xOri": "str",
- "xDest": "str",
- "qVag": 1
}, - "vag": [
- {
- "pesoBC": 0,
- "pesoR": 0,
- "tpVag": "str",
- "serie": "str",
- "nVag": 1,
- "nSeq": 1,
- "TU": 0
}
]
}
}, - "infDoc": {
- "infMunDescarga": [
- {
- "cMunDescarga": "string",
- "xMunDescarga": "string",
- "infCTe": [
- {
- "chCTe": "string",
- "SegCodBarra": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- null
], - "peri": [
- null
], - "infEntregaParcial": {
- "qtdTotal": null,
- "qtdParcial": null
}
}
], - "infNFe": [
- {
- "chNFe": "string",
- "SegCodBarra": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- null
], - "peri": [
- null
]
}
], - "infMDFeTransp": [
- {
- "chMDFe": "string",
- "indReentrega": 0,
- "infUnidTransp": [
- null
], - "peri": [
- null
]
}
]
}
]
}, - "seg": [
- {
- "infResp": {
- "respSeg": 0,
- "CNPJ": "string",
- "CPF": "string"
}, - "infSeg": {
- "xSeg": "string",
- "CNPJ": "string"
}, - "nApol": "string",
- "nAver": [
- "string"
]
}
], - "prodPred": {
- "tpCarga": "string",
- "xProd": "string",
- "cEAN": "string",
- "NCM": "string",
- "infLotacao": {
- "infLocalCarrega": {
- "CEP": "string",
- "latitude": "string",
- "longitude": "string"
}, - "infLocalDescarrega": {
- "CEP": "string",
- "latitude": "string",
- "longitude": "string"
}
}
}, - "tot": {
- "qCTe": 999999,
- "qNFe": 999999,
- "qMDFe": 999999,
- "vCarga": 0,
- "cUnid": "string",
- "qCarga": 0
}, - "lacres": [
- {
- "nLacre": "string"
}
], - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string"
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 999,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infMDFeSupl": {
- "qrCodMDFe": "stringstringstringstringstringstringstringstringst"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
], - "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string"
}
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 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:
path Parameters
id required | string ID único do lote gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Consulta MDF-e não encerrados
Authorizations:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
Responses
Response samples
- 200
{- "tpAmb": 0,
- "verAplic": "string",
- "cStat": 0,
- "xMotivo": "string",
- "cUF": 0,
- "infMDFe": [
- {
- "chMDFe": "string",
- "nProt": "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 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:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
autorizador | string Ambiente Autorizador. Autorizadores disponíveis: Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único do MDF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 o cancelamento do MDF-e
Authorizations:
path Parameters
id required | string ID único do MDF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "justificativa": "string"
}
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 encerramento do MDF-e
Authorizations:
path Parameters
id required | string ID único do MDF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "data_encerramento": "2019-08-24",
- "uf": "string",
- "codigo_municipio": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "data_encerramento": "2019-08-24",
- "uf": "string",
- "codigo_municipio": "string"
}
Response samples
- 200
{- "data_encerramento": "2019-08-24",
- "uf": "string",
- "codigo_municipio": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 condutor em um MDF-e autorizado
Authorizations:
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
- Payload
{- "nome_condutor": "string",
- "cpf_condutor": "string"
}
Response samples
- 200
{- "nome_condutor": "string",
- "cpf_condutor": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "codigo_municipio_carrega": "string",
- "municipio_carrega": "string",
- "documentos": [
- {
- "codigo_municipio_descarga": "string",
- "municipio_descarga": "string",
- "chave_acesso_nfe": "string"
}
], - "protocolo_autorizacao": "string"
}
Response samples
- 200
{- "codigo_municipio_carrega": "string",
- "municipio_carrega": "string",
- "documentos": [
- {
- "codigo_municipio_descarga": "string",
- "municipio_descarga": "string",
- "chave_acesso_nfe": "string"
}
], - "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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
autorizado
na 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.
Authorizations:
path Parameters
id required | string ID único do MDF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único do MDF-e gerado pela Nuvem Fiscal. |
Responses
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Emitir NF-e
Authorizations:
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
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:
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 |
dfe_id required | string ID único gerado pela Nuvem Fiscal para o documento fiscal. |
Responses
Response samples
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 evento
Authorizations:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
Inutilizar uma sequência de numeração de NF-e
Authorizations:
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
- Payload
{- "ambiente": "homologacao",
- "cnpj": "string",
- "ano": 0,
- "serie": 999,
- "numero_inicial": 1,
- "numero_final": 1,
- "justificativa": "stringstringstr"
}
Response samples
- 200
{- "cnpj": "string",
- "ano": 0,
- "modelo": 0,
- "serie": 0,
- "numero_inicial": 0,
- "numero_final": 0,
- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "cnpj": "string",
- "ano": 0,
- "modelo": 0,
- "serie": 0,
- "numero_inicial": 0,
- "numero_final": 0,
- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
]
}
Emitir lote de NF-e
Authorizations:
Request Body schema: application/json
required | Array of objects (NfePedidoEmissao) |
ambiente required | string Enum: "homologacao" "producao" Identificação do Ambiente. |
referencia | string Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
id_lote required | string |
Responses
Request samples
- Payload
{- "documentos": [
- {
- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- null
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": null,
- "chNFe": null,
- "qExport": null
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": null,
- "cUFOrig": null,
- "pOrig": null
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
], - "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string"
}
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 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:
path Parameters
id required | string ID único do lote gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
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.
Authorizations:
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:
|
mensagem_rodape | string Default: "" Imprime mensagem no rodapé do documento. O caractere Exemplos de Uso:
|
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "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.
Authorizations:
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "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:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
autorizador | string Ambiente Autorizador. Autorizadores disponíveis: Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único da NF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 o cancelamento da NF-e
Authorizations:
path Parameters
id required | string ID único da NF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "justificativa": "string"
}
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 solicitação de correção da NF-e
Authorizations:
path Parameters
id required | string ID único da NF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "correcao": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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.
Authorizations:
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 Correção a ser considerada. |
Responses
Request samples
- Payload
{- "correcao": "string"
}
Response samples
- 200
{- "correcao": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 DANFE
Authorizations:
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:
|
mensagem_rodape | string Default: "" Imprime mensagem no rodapé do documento. O caractere Exemplos de Uso:
|
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
autorizado
na 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.
Authorizations:
path Parameters
id required | string ID único da NF-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único da NF-e gerado pela Nuvem Fiscal. |
Responses
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
Emitir NFC-e
Authorizations:
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
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:
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 |
dfe_id required | string ID único gerado pela Nuvem Fiscal para o documento fiscal. |
Responses
Response samples
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 evento
Authorizations:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
Inutilizar uma sequência de numeração de NFC-e
Authorizations:
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
- Payload
{- "ambiente": "homologacao",
- "cnpj": "string",
- "ano": 0,
- "serie": 999,
- "numero_inicial": 1,
- "numero_final": 1,
- "justificativa": "stringstringstr"
}
Response samples
- 200
{- "cnpj": "string",
- "ano": 0,
- "modelo": 0,
- "serie": 0,
- "numero_inicial": 0,
- "numero_final": 0,
- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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:
path Parameters
id required | string ID único do evento gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "cnpj": "string",
- "ano": 0,
- "modelo": 0,
- "serie": 0,
- "numero_inicial": 0,
- "numero_final": 0,
- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
]
}
Emitir lote de NFC-e
Authorizations:
Request Body schema: application/json
required | Array of objects (NfePedidoEmissao) |
ambiente required | string Enum: "homologacao" "producao" Identificação do Ambiente. |
referencia | string Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
id_lote required | string |
Responses
Request samples
- Payload
{- "documentos": [
- {
- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- null
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": null,
- "chNFe": null,
- "qExport": null
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": null,
- "cUFOrig": null,
- "pOrig": null
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "ambiente": "homologacao",
- "referencia": "string"
}
], - "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string"
}
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 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:
path Parameters
id required | string ID único do lote gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "status": "pendente",
- "ambiente": "homologacao",
- "referencia": "string",
- "id_lote": "string",
- "recibo": {
- "numero": "string",
- "codigo_status": 0,
- "motivo_status": "string",
- "data_recebimento": "2019-08-24T14:15:22Z",
- "codigo_mensagem": 0,
- "mensagem": "string"
}, - "documentos": [
- {
- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
}
]
}
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.
Authorizations:
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 Default: "" Imprime mensagem no rodapé do documento. O caractere Exemplos de Uso:
|
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 Default: 80 Largura do DANFE NFC-e (em milímetros). |
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "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.
Authorizations:
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 Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento. |
Responses
Request samples
- Payload
{- "infNFe": {
- "versao": "string",
- "Id": "string",
- "ide": {
- "cUF": 0,
- "cNF": "string",
- "natOp": "string",
- "mod": 0,
- "serie": 999,
- "nNF": 1,
- "dhEmi": "2019-08-24T14:15:22Z",
- "dhSaiEnt": "2019-08-24T14:15:22Z",
- "tpNF": 0,
- "idDest": 0,
- "cMunFG": "string",
- "tpImp": 0,
- "tpEmis": 0,
- "cDV": 9,
- "tpAmb": 0,
- "finNFe": 0,
- "indFinal": 0,
- "indPres": 0,
- "indIntermed": 0,
- "procEmi": 0,
- "verProc": "string",
- "dhCont": "2019-08-24T14:15:22Z",
- "xJust": "stringstringstr",
- "NFref": [
- {
- "refNFe": "string",
- "refNFeSig": "string",
- "refNF": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refNFP": {
- "cUF": 0,
- "AAMM": "string",
- "CNPJ": "string",
- "CPF": "string",
- "IE": "string",
- "mod": "string",
- "serie": 999,
- "nNF": 1
}, - "refCTe": "string",
- "refECF": {
- "mod": "string",
- "nECF": 999,
- "nCOO": 999999
}
}
]
}, - "emit": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xFant": "string",
- "enderEmit": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "IE": "string",
- "IEST": "string",
- "IM": "string",
- "CNAE": "string",
- "CRT": 0
}, - "avulsa": {
- "CNPJ": "string",
- "xOrgao": "string",
- "matr": "string",
- "xAgente": "string",
- "fone": "string",
- "UF": "string",
- "nDAR": "string",
- "dEmi": "2019-08-24",
- "vDAR": 0,
- "repEmi": "string",
- "dPag": "2019-08-24"
}, - "dest": {
- "CNPJ": "string",
- "CPF": "string",
- "idEstrangeiro": "string",
- "xNome": "string",
- "enderDest": {
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string"
}, - "indIEDest": 0,
- "IE": "string",
- "ISUF": "string",
- "IM": "string",
- "email": "string"
}, - "retirada": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "entrega": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "xLgr": "string",
- "nro": "string",
- "xCpl": "string",
- "xBairro": "string",
- "cMun": "string",
- "xMun": "string",
- "UF": "string",
- "CEP": "string",
- "cPais": "string",
- "xPais": "string",
- "fone": "string",
- "email": "string",
- "IE": "string"
}, - "autXML": [
- {
- "CNPJ": "string",
- "CPF": "string"
}
], - "det": [
- {
- "nItem": 1,
- "prod": {
- "cProd": "string",
- "cEAN": "string",
- "cBarra": "string",
- "xProd": "string",
- "NCM": "string",
- "NVE": [
- "string"
], - "CEST": "string",
- "indEscala": "string",
- "CNPJFab": "string",
- "cBenef": "string",
- "gCred": [
- {
- "cCredPresumido": "string",
- "pCredPresumido": 0,
- "vCredPresumido": 0
}
], - "EXTIPI": "string",
- "CFOP": "string",
- "uCom": "string",
- "qCom": 0,
- "vUnCom": 0,
- "vProd": 0,
- "cEANTrib": "string",
- "cBarraTrib": "string",
- "uTrib": "string",
- "qTrib": 0,
- "vUnTrib": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vOutro": 0,
- "indTot": 0,
- "DI": [
- {
- "nDI": "string",
- "dDI": "2019-08-24",
- "xLocDesemb": "string",
- "UFDesemb": "string",
- "dDesemb": "2019-08-24",
- "tpViaTransp": 0,
- "vAFRMM": 0,
- "tpIntermedio": 0,
- "CNPJ": "string",
- "CPF": "string",
- "UFTerceiro": "string",
- "cExportador": "string",
- "adi": [
- {
- "nAdicao": 1,
- "nSeqAdic": 1,
- "cFabricante": "string",
- "vDescDI": 0,
- "nDraw": "string"
}
]
}
], - "detExport": [
- {
- "nDraw": "string",
- "exportInd": {
- "nRE": "string",
- "chNFe": "string",
- "qExport": 0
}
}
], - "xPed": "string",
- "nItemPed": 999999,
- "nFCI": "string",
- "rastro": [
- {
- "nLote": "string",
- "qLote": 0,
- "dFab": "2019-08-24",
- "dVal": "2019-08-24",
- "cAgreg": "string"
}
], - "infProdNFF": {
- "cProdFisco": "string",
- "cOperNFF": "string"
}, - "infProdEmb": {
- "xEmb": "string",
- "qVolEmb": 0,
- "uEmb": "string"
}, - "veicProd": {
- "tpOp": 0,
- "chassi": "string",
- "cCor": "stri",
- "xCor": "string",
- "pot": "stri",
- "cilin": "stri",
- "pesoL": "string",
- "pesoB": "string",
- "nSerie": "string",
- "tpComb": "st",
- "nMotor": "string",
- "CMT": "string",
- "dist": "stri",
- "anoMod": 9999,
- "anoFab": 9999,
- "tpPint": "s",
- "tpVeic": 99,
- "espVeic": 9,
- "VIN": "s",
- "condVeic": 0,
- "cMod": "string",
- "cCorDENATRAN": "st",
- "lota": 999,
- "tpRest": 0
}, - "med": {
- "cProdANVISA": "string",
- "xMotivoIsencao": "string",
- "vPMC": 0
}, - "arma": [
- {
- "tpArma": 0,
- "nSerie": "string",
- "nCano": "string",
- "descr": "string"
}
], - "comb": {
- "cProdANP": 999999999,
- "descANP": "string",
- "pGLP": 0,
- "pGNn": 0,
- "pGNi": 0,
- "vPart": 0,
- "CODIF": "string",
- "qTemp": 0,
- "UFCons": "string",
- "CIDE": {
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCIDE": 0
}, - "encerrante": {
- "nBico": 999,
- "nBomba": 999,
- "nTanque": 999,
- "vEncIni": 0,
- "vEncFin": 0
}, - "pBio": 0,
- "origComb": [
- {
- "indImport": 0,
- "cUFOrig": 0,
- "pOrig": 0
}
]
}, - "nRECOPI": "string"
}, - "imposto": {
- "vTotTrib": 0,
- "ICMS": {
- "ICMS00": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "pFCP": 0,
- "vFCP": 0
}, - "ICMS02": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0
}, - "ICMS10": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS15": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "adRemICMSReten": 0,
- "vICMSMonoReten": 0,
- "pRedAdRem": 0,
- "motRedAdRem": 0
}, - "ICMS20": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS30": {
- "orig": 0,
- "CST": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS40": {
- "orig": 0,
- "CST": "string",
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0
}, - "ICMS51": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "cBenefRBC": "string",
- "vBC": 0,
- "pICMS": 0,
- "vICMSOp": 0,
- "pDif": 0,
- "vICMSDif": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "pFCPDif": 0,
- "vFCPDif": 0,
- "vFCPEfet": 0
}, - "ICMS53": {
- "orig": 0,
- "CST": "string",
- "qBCMono": 0,
- "adRemICMS": 0,
- "vICMSMonoOp": 0,
- "pDif": 0,
- "vICMSMonoDif": 0,
- "vICMSMono": 0,
- "qBCMonoDif": 0,
- "adRemICMSDif": 0
}, - "ICMS60": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMS61": {
- "orig": 0,
- "CST": "string",
- "qBCMonoRet": 0,
- "adRemICMSRet": 0,
- "vICMSMonoRet": 0
}, - "ICMS70": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "pRedBC": 0,
- "vBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMS90": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "vBCFCP": 0,
- "pFCP": 0,
- "vFCP": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "vICMSDeson": 0,
- "motDesICMS": 0,
- "indDeduzDeson": 0,
- "vICMSSTDeson": 0,
- "motDesICMSST": 0
}, - "ICMSPart": {
- "orig": 0,
- "CST": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pBCOp": 0,
- "UFST": "string"
}, - "ICMSST": {
- "orig": 0,
- "CST": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "vBCSTDest": 0,
- "vICMSSTDest": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN101": {
- "orig": 0,
- "CSOSN": "string",
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN102": {
- "orig": 0,
- "CSOSN": "string"
}, - "ICMSSN201": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}, - "ICMSSN202": {
- "orig": 0,
- "CSOSN": "string",
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0
}, - "ICMSSN500": {
- "orig": 0,
- "CSOSN": "string",
- "vBCSTRet": 0,
- "pST": 0,
- "vICMSSubstituto": 0,
- "vICMSSTRet": 0,
- "vBCFCPSTRet": 0,
- "pFCPSTRet": 0,
- "vFCPSTRet": 0,
- "pRedBCEfet": 0,
- "vBCEfet": 0,
- "pICMSEfet": 0,
- "vICMSEfet": 0
}, - "ICMSSN900": {
- "orig": 0,
- "CSOSN": "string",
- "modBC": 0,
- "vBC": 0,
- "pRedBC": 0,
- "pICMS": 0,
- "vICMS": 0,
- "modBCST": 0,
- "pMVAST": 0,
- "pRedBCST": 0,
- "vBCST": 0,
- "pICMSST": 0,
- "vICMSST": 0,
- "vBCFCPST": 0,
- "pFCPST": 0,
- "vFCPST": 0,
- "pCredSN": 0,
- "vCredICMSSN": 0
}
}, - "IPI": {
- "CNPJProd": "string",
- "cSelo": "string",
- "qSelo": 0,
- "cEnq": "str",
- "IPITrib": {
- "CST": "string",
- "vBC": 0,
- "pIPI": 0,
- "qUnid": 0,
- "vUnid": 0,
- "vIPI": 0
}, - "IPINT": {
- "CST": "string"
}
}, - "II": {
- "vBC": 0,
- "vDespAdu": 0,
- "vII": 0,
- "vIOF": 0
}, - "ISSQN": {
- "vBC": 0,
- "vAliq": 0,
- "vISSQN": 0,
- "cMunFG": "string",
- "cListServ": "string",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "indISS": 0,
- "cServico": "string",
- "cMun": "string",
- "cPais": "string",
- "nProcesso": "string",
- "indIncentivo": 0
}, - "PIS": {
- "PISAliq": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "vPIS": 0
}, - "PISQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}, - "PISNT": {
- "CST": "string"
}, - "PISOutr": {
- "CST": "string",
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0
}
}, - "PISST": {
- "vBC": 0,
- "pPIS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vPIS": 0,
- "indSomaPISST": 0
}, - "COFINS": {
- "COFINSAliq": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "vCOFINS": 0
}, - "COFINSQtde": {
- "CST": "string",
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}, - "COFINSNT": {
- "CST": "string"
}, - "COFINSOutr": {
- "CST": "string",
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0
}
}, - "COFINSST": {
- "vBC": 0,
- "pCOFINS": 0,
- "qBCProd": 0,
- "vAliqProd": 0,
- "vCOFINS": 0,
- "indSomaCOFINSST": 0
}, - "ICMSUFDest": {
- "vBCUFDest": 0,
- "vBCFCPUFDest": 0,
- "pFCPUFDest": 0,
- "pICMSUFDest": 0,
- "pICMSInter": 0,
- "pICMSInterPart": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0
}
}, - "impostoDevol": {
- "pDevol": 0,
- "IPI": {
- "vIPIDevol": 0
}
}, - "infAdProd": "string",
- "obsItem": {
- "obsCont": {
- "xCampo": "string",
- "xTexto": "string"
}, - "obsFisco": {
- "xCampo": "string",
- "xTexto": "string"
}
}
}
], - "total": {
- "ICMSTot": {
- "vBC": 0,
- "vICMS": 0,
- "vICMSDeson": 0,
- "vFCPUFDest": 0,
- "vICMSUFDest": 0,
- "vICMSUFRemet": 0,
- "vFCP": 0,
- "vBCST": 0,
- "vST": 0,
- "vFCPST": 0,
- "vFCPSTRet": 0,
- "qBCMono": 0,
- "vICMSMono": 0,
- "qBCMonoReten": 0,
- "vICMSMonoReten": 0,
- "qBCMonoRet": 0,
- "vICMSMonoRet": 0,
- "vProd": 0,
- "vFrete": 0,
- "vSeg": 0,
- "vDesc": 0,
- "vII": 0,
- "vIPI": 0,
- "vIPIDevol": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "vOutro": 0,
- "vNF": 0,
- "vTotTrib": 0
}, - "ISSQNtot": {
- "vServ": 0,
- "vBC": 0,
- "vISS": 0,
- "vPIS": 0,
- "vCOFINS": 0,
- "dCompet": "2019-08-24",
- "vDeducao": 0,
- "vOutro": 0,
- "vDescIncond": 0,
- "vDescCond": 0,
- "vISSRet": 0,
- "cRegTrib": 0
}, - "retTrib": {
- "vRetPIS": 0,
- "vRetCOFINS": 0,
- "vRetCSLL": 0,
- "vBCIRRF": 0,
- "vIRRF": 0,
- "vBCRetPrev": 0,
- "vRetPrev": 0
}
}, - "transp": {
- "modFrete": 0,
- "transporta": {
- "CNPJ": "string",
- "CPF": "string",
- "xNome": "string",
- "IE": "string",
- "xEnder": "string",
- "xMun": "string",
- "UF": "string"
}, - "retTransp": {
- "vServ": 0,
- "vBCRet": 0,
- "pICMSRet": 0,
- "vICMSRet": 0,
- "CFOP": "string",
- "cMunFG": "string"
}, - "veicTransp": {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}, - "reboque": [
- {
- "placa": "string",
- "UF": "string",
- "RNTC": "string"
}
], - "vagao": "string",
- "balsa": "string",
- "vol": [
- {
- "qVol": 0,
- "esp": "string",
- "marca": "string",
- "nVol": "string",
- "pesoL": 0,
- "pesoB": 0,
- "lacres": [
- {
- "nLacre": "string"
}
]
}
]
}, - "cobr": {
- "fat": {
- "nFat": "string",
- "vOrig": 0,
- "vDesc": 0,
- "vLiq": 0
}, - "dup": [
- {
- "nDup": "string",
- "dVenc": "2019-08-24",
- "vDup": 0
}
]
}, - "pag": {
- "detPag": [
- {
- "indPag": 0,
- "tPag": "string",
- "xPag": "string",
- "vPag": 0,
- "dPag": "2019-08-24",
- "CNPJPag": "string",
- "UFPag": "string",
- "card": {
- "tpIntegra": 0,
- "CNPJ": "string",
- "tBand": "string",
- "cAut": "string",
- "CNPJReceb": "string",
- "idTermPag": "string"
}
}
], - "vTroco": 0
}, - "infIntermed": {
- "CNPJ": "string",
- "idCadIntTran": "string"
}, - "infAdic": {
- "infAdFisco": "string",
- "infCpl": "string",
- "obsCont": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "obsFisco": [
- {
- "xCampo": "string",
- "xTexto": "string"
}
], - "procRef": [
- {
- "nProc": "string",
- "indProc": 0,
- "tpAto": "string"
}
]
}, - "exporta": {
- "UFSaidaPais": "string",
- "xLocExporta": "string",
- "xLocDespacho": "string"
}, - "compra": {
- "xNEmp": "string",
- "xPed": "string",
- "xCont": "string"
}, - "cana": {
- "safra": "string",
- "ref": "string",
- "forDia": [
- {
- "dia": 1,
- "qtde": 0
}
], - "qTotMes": 0,
- "qTotAnt": 0,
- "qTotGer": 0,
- "deduc": [
- {
- "xDed": "string",
- "vDed": 0
}
], - "vFor": 0,
- "vTotDed": 0,
- "vLiqFor": 0
}, - "infRespTec": {
- "CNPJ": "string",
- "xContato": "string",
- "email": "string",
- "fone": "string",
- "idCSRT": 99,
- "hashCSRT": "string"
}, - "infSolicNFF": {
- "xSolic": "string"
}
}, - "infNFeSupl": {
- "qrCode": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstri",
- "urlChave": "stringstringstringstr"
}, - "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:
query Parameters
cpf_cnpj required | string CPF/CNPJ do emitente. Utilize o valor sem máscara. |
autorizador | string Ambiente Autorizador. Autorizadores disponíveis: Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único da NFC-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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": {
- "digest_value": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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 o cancelamento da NFC-e
Authorizations:
path Parameters
id required | string ID único da NFC-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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
Authorizations:
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
- Payload
{- "justificativa": "string"
}
Response samples
- 200
{- "justificativa": "string",
- "id": "string",
- "ambiente": "homologacao",
- "status": "pendente",
- "autor": {
- "cpf_cnpj": "string"
}, - "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"
}
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:
path Parameters
id required | string ID único da NFC-e gerado pela Nuvem Fiscal. |
query Parameters
modelo | integer Default: 1 Modelo da impressora:
|
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:
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 Default: "" Imprime mensagem no rodapé do documento. O caractere Exemplos de Uso:
|
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 Default: 80 Largura do DANFE NFC-e (em milímetros). |
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
autorizado
na 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.
Authorizations:
path Parameters
id required | string ID único da NFC-e gerado pela Nuvem Fiscal. |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string ID único da NFC-e gerado pela Nuvem Fiscal. |
Responses
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".
Authorizations:
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 |
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
- 200
{- "@count": 0,
- "data": [
- {
- "cnpj": "string",
- "razao_social": "string",
- "nome_fantasia": "string",
- "data_inicio_atividade": "2019-08-24",
- "matriz": true,
- "natureza_juridica": {
- "codigo": "string",
- "descricao": "string"
}, - "capital_social": 0,
- "porte": {
- "codigo": "string",
- "descricao": "string"
}, - "ente_federativo_responsavel": "string",
- "situacao_cadastral": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "motivo_situacao_cadastral": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "nome_da_cidade_no_exterior": "string",
- "pais": {
- "codigo": "string",
- "descricao": "string"
}, - "atividade_principal": {
- "codigo": "string",
- "descricao": "string"
}, - "atividades_secundarias": [
- {
- "codigo": "string",
- "descricao": "string"
}
], - "endereco": {
- "tipo_logradouro": "string",
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "cep": "string",
- "uf": "string",
- "municipio": {
- "codigo_tom": "string",
- "codigo_ibge": "string",
- "descricao": "string"
}
}, - "telefones": [
- {
- "ddd": "string",
- "numero": "string"
}
], - "email": "string",
- "situacao_especial": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "simples": {
- "optante": true,
- "data_opcao": "2019-08-24",
- "data_exclusao": "2019-08-24"
}, - "simei": {
- "optante": true,
- "data_opcao": "2019-08-24",
- "data_exclusao": "2019-08-24"
}, - "socios": [
- {
- "identificador_socio": {
- "codigo": "string",
- "descricao": "string"
}, - "nome": "string",
- "cpf_cnpj": "string",
- "qualificacao": {
- "codigo": "string",
- "descricao": "string"
}, - "data_entrada_sociedade": "2019-08-24",
- "pais": {
- "codigo": "string",
- "descricao": "string"
}, - "representante_legal": {
- "cpf": "string",
- "nome": "string",
- "qualificacao": {
- "codigo": "string",
- "descricao": "string"
}
}, - "faixa_etaria": {
- "codigo": "string",
- "descricao": "string"
}
}
]
}
]
}
Consultar dados do CNPJ
Authorizations:
path Parameters
Cnpj required | string CNPJ sem máscara. |
Responses
Response samples
- 200
{- "cnpj": "string",
- "razao_social": "string",
- "nome_fantasia": "string",
- "data_inicio_atividade": "2019-08-24",
- "matriz": true,
- "natureza_juridica": {
- "codigo": "string",
- "descricao": "string"
}, - "capital_social": 0,
- "porte": {
- "codigo": "string",
- "descricao": "string"
}, - "ente_federativo_responsavel": "string",
- "situacao_cadastral": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "motivo_situacao_cadastral": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "nome_da_cidade_no_exterior": "string",
- "pais": {
- "codigo": "string",
- "descricao": "string"
}, - "atividade_principal": {
- "codigo": "string",
- "descricao": "string"
}, - "atividades_secundarias": [
- {
- "codigo": "string",
- "descricao": "string"
}
], - "endereco": {
- "tipo_logradouro": "string",
- "logradouro": "string",
- "numero": "string",
- "complemento": "string",
- "bairro": "string",
- "cep": "string",
- "uf": "string",
- "municipio": {
- "codigo_tom": "string",
- "codigo_ibge": "string",
- "descricao": "string"
}
}, - "telefones": [
- {
- "ddd": "string",
- "numero": "string"
}
], - "email": "string",
- "situacao_especial": {
- "data": "2019-08-24",
- "codigo": "string",
- "descricao": "string"
}, - "simples": {
- "optante": true,
- "data_opcao": "2019-08-24",
- "data_exclusao": "2019-08-24"
}, - "simei": {
- "optante": true,
- "data_opcao": "2019-08-24",
- "data_exclusao": "2019-08-24"
}, - "socios": [
- {
- "identificador_socio": {
- "codigo": "string",
- "descricao": "string"
}, - "nome": "string",
- "cpf_cnpj": "string",
- "qualificacao": {
- "codigo": "string",
- "descricao": "string"
}, - "data_entrada_sociedade": "2019-08-24",
- "pais": {
- "codigo": "string",
- "descricao": "string"
}, - "representante_legal": {
- "cpf": "string",
- "nome": "string",
- "qualificacao": {
- "codigo": "string",
- "descricao": "string"
}
}, - "faixa_etaria": {
- "codigo": "string",
- "descricao": "string"
}
}
]
}
Consultar endereço através do CEP
Authorizations:
path Parameters
Cep required | string CEP sem máscara. |
Responses
Response samples
- 200
{- "bairro": "string",
- "cep": "string",
- "codigo_ibge": "string",
- "complemento": "string",
- "logradouro": "string",
- "municipio": "string",
- "tipo_logradouro": "string",
- "uf": "string"
}