API - Envio Normal Híbrido da NFC-e

API - Envio Normal Híbrida NFC-e

POST que/api/nfce/enviohibridanormal

API utilizada no Modelo Híbrido para uma NFC-e

Headers

Name Type Description

Name	Type	Description
Content-type	string	`application/x-www-form-urlencoded`
Accept	string	`application/json`
Authorization	string	`bearer <valor>`

Content-type

string

application/x-www-form-urlencoded

string

application/json

Authorization

string

bearer <valor>

Request Body

Name Type Description

Name	Type	Description
ambiente	integer	Informar o tipo de ambiente a ser utilizado. Verifique através da API: Tipo de Ambiente.
idUF	integer	Informar o ID do estado da empresa
codigoAleatorioNF	integer	Informar um código aleatório individual para cada nota com no máximo 8 caracteres.
naturezaDaOperacao	integer	Informar a natureza da operação. Verifique através da API: Natureza da Operação.
dataPrestacaoServico	string	Informar a Data/Hora de entrada em contingência. Exemplo: `2019-01-03`. Utilizado para emissão de uma Nota Fiscal Conjugada.
indicadorDaFormaDePagamento	integer	Informar forma de pagamento. Este pode ser consultada por meio da API: Indicador da Forma de Pagamento
serie	integer	Informar o número de série do documento.
numeroNF	integer	Informar o número do documento.
tipoDaOperacao	integer	Informar o tipo da operação.
destinoDaOperacao	integer	Informar o destino da operação.
idMunicipioFatoGeradorICMS	integer	Informar o ID do município gerador do ICMS. Você pode verificar o ID de municípios através das APIs: Municípios
tipoImpressaoDanfe	integer	Informar o formato de impressão do DANFE. O tipo de impressão pode ser consultado por meio da API: Tipo de impressão do DANFE
finalidadeEmissao	integer	Informar a finalidade de emissão. A finalidade de emissão pode ser consultada por meio da API: Finalidade da Emissão
indicadorConsumidorFinal	integer	Informar se é uma operação com consumidor final ou não, da seguinte maneira:`true`=Operação com consumidor final; `false`=Operação normal
indicadorVendaPresencial	integer	Informar o indicador de presença da venda. O indicador de presença pode ser consultado por meio da API: Indicador de Presença
idEmpresaEmitente	integer	Informar o ID da empresa. Podemos consultar o ID Empresa pela API: Empresa
produtos	array[Produto]	Campo identificador do Array de produtos
formasDePagamento	array[FormaDePagamento]	Campo identificador do Array de forma de pagamento
destinatarioDaNFCe	Destinatario	Campo identificador do destinatário da NFC-e
valorDoTroco	number	Informar o valor do troco quando o valor pago for maior que o valor total da nota
cnae	integer	Informar a Classificação Nacional de Atividades Econômicas quando a NFC-e possuir serviço
transporte	Transporte	Campo identificador do Transporte
Produto: {id}	integer	Informar o ID do produto
Produto: {cfop}	integer	Informar o Código Fiscal de Operações e Prestações do produto. Exemplo: `5101`
Produto: {quantidade}	number	Informar a quantidade do produto. Exemplo: `3`
Produto: {valorUnitarioComercial}	number	Este campo permite enviar um valor diferente do cadastrado no produto. Exemplo: `50.00`
Produto: {descontoNoItem}	number	Este campo permite informar um desconto para o item. Exemplo: `10.00`
Produto: {descricaoDoItem}	string	Este campo permite informar uma descrição diferente da cadastrada no produto. Exemplo: `Teste`
Produto: {informacaoAdicionalItem}	string	Este campo permite inserir uma informação adicional ao item. Exemplo: `Teste`
FormaDePagamento: {tipoPagamento}	integer	Informar o tipo da forma de pagamento
FormaDePagamento: {valorPagamento}	number	Informar o valor do pagamento. Exemplo: `50.00`
FormaDePagamento: {tipoDeIntegracaoParaPagamento}	integer	Informar o tipo da integração para pagamento
FormaDePagamento: {cnpjDaCredenciadoraDoCartao}	string	Informar o CNPJ da credenciadora. Exemplo: `5943832500010`1
FormaDePagamento: {bandeiraDaOperadoraDoCartao}	integer	Informar a Bandeira da credenciadora
FormaDePagamento: {numeroDaAutorizacaoDaOperacaoComCartao}	string	Informar o número de autorização. Exemplo: `12345678912345`
Destinatario: {cnpj}	string	Informar o CNPJ do destinatário. Informar este campo se o consumidor for pessoa jurídica. Exemplo: `12123123000101`
Destinatario: {cpf}	string	Informar o CPF do destinatário. Informar este campo se o consumidor for pessoa física. Exemplo: `12312312312`
Destinatario: {nomeDestinatario}	int	Informar o nome do destinatário. Exemplo: `Destinatário teste`
Destinatario: {emailDestinatario}	int	Informar o e-mail do destinatário. Exemplo: `teste@teste.com.br`
Destinatario: {endereco}	Endereco	Campo identificador do endereço do destinatário
Transporte: {modFrete}	int	Informar a modalidade de frete
Transporte: {transporta}	Transportadora	Campo identificador da Transportadora
Endereco: {logradouro}	int	Informar o logradouro do destinatário. Exemplo: "Rua teste"
Endereco: {numero}	int	Informar o número do endereço do destinatário. Exemplo: `999`
Endereco: {bairro}	int	Informar o bairro do destinatário. Exemplo: `Jardim teste`
Endereco: {idMunicipio}	int	Informar o ID do município do destinatário
Transportadora: {cnpj}	int	Informar o CNPJ do responsável pelo transporte. Exemplo: `12312312312`
Transportadora: {cpf}	int	Informar o CPF do responsável pelo transporte. Exemplo: `12312312312`
Transportadora: {xNome}	int	Informar o nome do responsável pelo transporte
Transportadora: {ie}	int	Informar a IE do responsável pelo transporte
Transportadora: {xEnder}	int	Informar o endereço do responsável pelo transporte
Transportadora: {xMun}	int	Informar o ID do município do responsável pelo transporte
Transportadora: {uf}	int	Informar a UF do responsável pelo transporte

ambiente

integer

Informar o tipo de ambiente a ser utilizado. Verifique através da API: Tipo de Ambiente.

idUF

integer

Informar o ID do estado da empresa

codigoAleatorioNF

integer

Informar um código aleatório individual para cada nota com no máximo 8 caracteres.

naturezaDaOperacao

integer

Informar a natureza da operação. Verifique através da API: Natureza da Operação.

dataPrestacaoServico

string

Informar a Data/Hora de entrada em contingência. Exemplo: 2019-01-03. Utilizado para emissão de uma Nota Fiscal Conjugada.

indicadorDaFormaDePagamento

integer

Informar forma de pagamento. Este pode ser consultada por meio da API: Indicador da Forma de Pagamento

serie

integer

Informar o número de série do documento.

numeroNF

integer

Informar o número do documento.

tipoDaOperacao

integer

Informar o tipo da operação.

destinoDaOperacao

integer

Informar o destino da operação.

idMunicipioFatoGeradorICMS

integer

Informar o ID do município gerador do ICMS. Você pode verificar o ID de municípios através das APIs: Municípios

tipoImpressaoDanfe

integer

Informar o formato de impressão do DANFE. O tipo de impressão pode ser consultado por meio da API: Tipo de impressão do DANFE

finalidadeEmissao

integer

Informar a finalidade de emissão. A finalidade de emissão pode ser consultada por meio da API: Finalidade da Emissão

indicadorConsumidorFinal

integer

Informar se é uma operação com consumidor final ou não, da seguinte maneira:true=Operação com consumidor final; false=Operação normal

indicadorVendaPresencial

integer

Informar o indicador de presença da venda. O indicador de presença pode ser consultado por meio da API: Indicador de Presença

idEmpresaEmitente

integer

Informar o ID da empresa. Podemos consultar o ID Empresa pela API: Empresa

produtos

array[Produto]

Campo identificador do Array de produtos

formasDePagamento

array[FormaDePagamento]

Campo identificador do Array de forma de pagamento

destinatarioDaNFCe

Destinatario

Campo identificador do destinatário da NFC-e

valorDoTroco

number

Informar o valor do troco quando o valor pago for maior que o valor total da nota

cnae

integer

Informar a Classificação Nacional de Atividades Econômicas quando a NFC-e possuir serviço

transporte

Transporte

Campo identificador do Transporte

Produto: {id}

integer

Informar o ID do produto

Produto: {cfop}

integer

Informar o Código Fiscal de Operações e Prestações do produto. Exemplo: 5101

Produto: {quantidade}

number

Informar a quantidade do produto. Exemplo: 3

Produto: {valorUnitarioComercial}

number

Este campo permite enviar um valor diferente do cadastrado no produto. Exemplo: 50.00

Produto: {descontoNoItem}

number

Este campo permite informar um desconto para o item. Exemplo: 10.00

Produto: {descricaoDoItem}

string

Este campo permite informar uma descrição diferente da cadastrada no produto. Exemplo: Teste

Produto: {informacaoAdicionalItem}

string

Este campo permite inserir uma informação adicional ao item. Exemplo: Teste

FormaDePagamento: {tipoPagamento}

integer

Informar o tipo da forma de pagamento

FormaDePagamento: {valorPagamento}

number

Informar o valor do pagamento. Exemplo: 50.00

FormaDePagamento: {tipoDeIntegracaoParaPagamento}

integer

Informar o tipo da integração para pagamento

FormaDePagamento: {cnpjDaCredenciadoraDoCartao}

string

Informar o CNPJ da credenciadora. Exemplo: 59438325000101

FormaDePagamento: {bandeiraDaOperadoraDoCartao}

integer

Informar a Bandeira da credenciadora

FormaDePagamento: {numeroDaAutorizacaoDaOperacaoComCartao}

string

Informar o número de autorização. Exemplo: 12345678912345

Destinatario: {cnpj}

string

Informar o CNPJ do destinatário. Informar este campo se o consumidor for pessoa jurídica. Exemplo: 12123123000101

Destinatario: {cpf}

string

Informar o CPF do destinatário. Informar este campo se o consumidor for pessoa física. Exemplo: 12312312312

Destinatario: {nomeDestinatario}

int

Informar o nome do destinatário. Exemplo: Destinatário teste

Destinatario: {emailDestinatario}

int

Informar o e-mail do destinatário. Exemplo: teste@teste.com.br

Destinatario: {endereco}

Endereco

Campo identificador do endereço do destinatário

Transporte: {modFrete}

int

Informar a modalidade de frete

Transporte: {transporta}

Transportadora

Campo identificador da Transportadora

Endereco: {logradouro}

int

Informar o logradouro do destinatário. Exemplo: "Rua teste"

Endereco: {numero}

int

Informar o número do endereço do destinatário. Exemplo: 999

Endereco: {bairro}

int

Informar o bairro do destinatário. Exemplo: Jardim teste

Endereco: {idMunicipio}

int

Informar o ID do município do destinatário

Transportadora: {cnpj}

int

Informar o CNPJ do responsável pelo transporte. Exemplo: 12312312312

Transportadora: {cpf}

int

Informar o CPF do responsável pelo transporte. Exemplo: 12312312312

Transportadora: {xNome}

int

Informar o nome do responsável pelo transporte

Transportadora: {ie}

int

Informar a IE do responsável pelo transporte

Transportadora: {xEnder}

int

Informar o endereço do responsável pelo transporte

Transportadora: {xMun}

int

Informar o ID do município do responsável pelo transporte

Transportadora: {uf}

int

Informar a UF do responsável pelo transporte

{
  "dadosDoDocumento": {
    "id": 1679479,
    "chaveDeAcesso": "13210817921427000125650670000001261123456780",
    "dataHoraEmissao": "2021-08-18T15:06:13.2483404Z",
    "dataDeAutorizacao": "2021-08-18T15:06:14Z",
    // Indica se a NFC-e possui rejeição/timedout
    "documentoComErro": false,
    "codigoStatusSEFAZ": "100",
    "descricaoStatusSEFAZ": "Autorizado o uso da NF-e",
    "protocoloSEFAZ": "113210009464207",
    "urlConsultaViaQRCode": "http://homnfce.sefaz.am.gov.br/nfceweb/formConsulta.do?p=13210817921427000125650670000001261123456780|2|2|1|7352FBBE4DCA7CCC5EBB3603103C8ECF0C74304F",
    "urlConsultaViaChaveDeAcesso": "http://www.sefaz.am.gov.br/nfce/consulta",
    // Indica se a numeração já foi utilizada. Se true, é apenas uma consulta na base de dados invoiSys
    "documentoJaEmitidoAnteriormente": false,
    "status": {
    // Código que indica autorização no sistema
      "key": 0,
      "value": "Autorizado"
    },
    "codigoMensagemSEFAZ": null,
    "descricaoMensagemSEFAZ": null
  },
  "acoes": {
    // Indica se a NFC-e deve ser corrigida antes de ser reenviada
    "corrigirDocumento": false,
    // Indica se a NFC-e deve ser cancelada/inutilizada
    "cancelar": false,
    // Indica se a NFC-e deve ser enviada em contingência na numeração seguinte
    "enviarContingencia": false,
    // Indica se é necessário tentar o reenvio mais tarde da mesma numeração
    "tentarNovamenteMaisTarde": false,
    // Indica que o parceiro deve entrar em contato com o suporte invoiSys
    "entrarEmContatoComSuporteImediatamente": false
  },
  "excecao": null
}

Modelo de Envio 📝

{
 // 1 = prod, 2 = hom
 "ambiente": 2,
 // ID interno da UF na invoiSys (Obtido na API UF)
 "idUF": 3,
 // Código aleatório gerado pelo parceiro
 "codigoAleatorioNF": 12345678,
 // 1 = venda, 2 = compra, 3 = transferência, 4 = devolução 
 // 5 = importação, 6 = consignação e 7 = remessa
 "naturezaDaOperacao": 1,
 // 0 = à vista, à prazo = 1
 "indicadorDaFormaDePagamento": 0,
 "serie": 1,
 "numeroNF": 1,
 "tipoDaOperacao": 1,
 "destinoDaOperacao": 1,
 // ID interno do municipio fato gerado do ICMS na invoiSys (Obtido na API Municipio)
 "idMunicipioFatoGeradorICMS": 000,
 // 4 = DANFE NFC-e, 5 = DANFE NFC-e em mensagem eletrônica
 "tipoImpressaoDanfe": 4,
 // 1 = NF-e normal, 2 = NF-e complementar, 3 = NF-e de ajuste
 // 4 = Devolução de mercadoria
 "finalidadeEmissao": 1,
 "indicadorConsumidorFinal": true,
 // 1 = Operação presencial, 4 = NFC-e em operação com entrega a domicílio
 "indicadorVendaPresencial": 1,
 // ID interno da empresa na invoiSys
 "idEmpresaEmitente": 0000,
 "produtos": [
   {
    // ID interno do produto na invoiSys 
     "id": 000,
     "cfop": 5101,
     "quantidade": 1
   }
 ],
 "formasDePagamento": [
   {
// 01 = Dinheiro, 02 = Cheque, 03 = Cartão de Crédito, 04 = Cartão de Débito
// 05 = Crédito Loja, 10 = Vale Alimentação, 11 = Vale Refeição
// 12 = Vale Presente, 13 = Vale Combustível, 15 = Boleto Bancário
// 16 = Depósito Bancário, 17 = Pagamento Instantâneo (PIX)
// 18=Transferência bancária, Carteira Digital, 19=Programa de fidelidade, Cashback, Crédito Virtual
// 90= Sem pagamento, 99=Outros
     "tipoPagamento": 1,
     "valorPagamento": 1.00
   }
 ],
  "transporte": {
// 0 = CIF, 1 = FOB,
// 2 = Contratação do Frete por conta de Terceiros,
// 3 = Transporte Próprio por conta do Remetente,
// 4 = Transporte Próprio por conta do Destinatário,
// 9 = Sem Ocorrência de Transporte
    "modFrete": 9
  },
 "valorDoTroco": 0
}

API's Relacionadas 🎈

Referências à API 📌

PreviousAPI - Envio Normal Completo da NFC-e NextAPI - Envio Contingência Completo da NFC-e

Last updated 2 years ago