Através deste endpoint, é possível enviar um txt ou json de uma NF-e, que será convertida para um xml sem as informações de assinatura.
URL
Produção: POST https://nfe.ns.eti.br/util/generatexml
Dados de entrada
Os dados de entrada deste método seguem o padrão da emissão de NF-e, segundo o formato dos dados.
Envio de dados em formato JSON
Para envio dos dados em JSON do Content-Type da requisição deverá ser definido como application/json. O token pode ser informado tanto no corpo como no cabeçalho da requisição.
| Campo | Descrição |
|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário |
| NFe | Dados da NF-e (conforme Manual de Orientações do Contribuinte da Sefaz) |
Envio de dados em formato TXT
Para envio dos dados em TXT o Content-Type da requisição deverá ser definido como text/plain;charset=utf-8 e o X-AUTH-TOKEN deverá ser enviado no cabeçalho HTTP.
No envio em formato TXT o corpo da requisição deverá conter o conteúdo do TXT com as informações da NF-e. Esse conteúdo deverá ser gerado a partir do layout do TXT de emissão do integrador local da NS Tecnologia.
É possível fazer a emissão utilizando também o layout do emissor público. Para isso, basta apenas enviar o conteúdo do TXT neste layout e informar nas headers da requisição a header layout com o valor publico.
Exemplos de requisição
Requisição com NF-e em JSON
curl -X POST
\-H "Content-Type: application/json"
\-H "X-AUTH-TOKEN: SEU_TOKEN"
\-d '{
"NFe":{...}
}' \
https://nfe.ns.eti.br/util/generatexml
Requisição com NF-e em TXTRequisição com NF-e em TXT
curl -X POST
\-H "X-AUTH-TOKEN: SEU_TOKEN"
\-H "Content-Type: text/plain"
\-d 'NOTA FISCAL|1| \A|3.10||'
\https://nfe.ns.eti.br/util/generatexml
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| xml | XML gerado a partir do json ou txt | Somente em status = 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Xml gerado com sucesso",
"xml": "<NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\">....</NFe>"
}
Retorno com erro de dados
{
"status": -2,
"motivo": "NFe invalido de acordo com a validacao contra schema",
"erros": ["cvc-pattern-valid: Value '9618000' is not facet-valid with respect to pattern '[0-9]{8}' for type '#AnonType_CEPTEndereco'.","O campo 'CEP' foi preenchido incorretamente com o valor '9618000'. Este campo deve ser preenchido com numeros e conter exatamente 8 caracteres."]
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Xml gerado com sucesso |
| -2 | Erro de informações de acordo com o tipo de dadosVerifique o campo motivo para identificar os campos incorretos |
| -3 | Schema de validação inexistente para a versão da NF-e informada em NFe/infNfe/versao |
| -4 | Dados enviados fora do padrão esperadoVerifique o campo motivo para maiores informações |
Gerar XML de Cancelamento
Através deste endpoint, é possível enviar um json de cancelamento que será convertido para um xml sem as informações de assinatura.
URL
Produção: POST https://nfe.ns.eti.br/util/generatecancel
Dados de entrada
Os dados de entrada deste método são os mesmos do Cancelamento na NS NF-e API
| Campo | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| chNFe | Chave de acesso da NF-e | |
| tpAmb | Tipo do ambiente de autorização da NF-e: 1 - Produção2 - Homologação | |
| dhEvento | Data e hora da ocorrência do cancelamento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
| nProt | Número do protocolo de autorização da NF-e | |
| xJust | Descrição literal do motivo de cancelamento da NF-e | Mínimo 15 caracteres |
Exemplo de requisição
Requisição de cancelamento de NF-e
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chNFe": "43161107364617000135550000000099601000094832",
"tpAmb": "2",
"dhEvento": "2016-11-28T19:06:14-02:00",
"nProt": "143160001510168",
"xJust": "NF-e cancelada para teste de desenvolvimento de software de integração"
}'
\https://nfe.ns.eti.br/util/generatecancel
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| xml | XML gerado a partir do json | Somente status = 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Xml gerado com sucesso",
"xml": "<evento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\" >....</evento>"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Xml gerado com sucesso |
| -2 | Chave de acesso inválida: CHAVE. A chave deve conter 44 caracteres numericos. |
Gerar XML de Carta de Correção
Através deste endpoint, é possível enviar um json de carta de correção que será convertido para um xml sem as informações de assinatura.
URL
Produção: POST https://nfe.ns.eti.br/util/generatecce
Dados de entrada
Os dados de entrada deste método são os mesmos da Carta de Correção na NS NF-e API
| Campo | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| chNFe | Chave de acesso da NF-e | |
| tpAmb | Tipo do ambiente de autorização da NF-e: 1 - Produção2 - Homologação | |
| dhEvento | Data e hora da ocorrência do cancelamento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
| nSeqEvento | Número sequencial do evento | Sequencial do evento para o mesmo tipo de eventoO autor do evento deve numerar de forma sequencial |
| xCorrecao | Descrição da correção a ser realizada na NF-e | Ex.: "VALIDADE DA LICENCA DE 01/09/2015 A 01/09/2016." |
Exemplo de requisição
Requisição de CCe de NF-e
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"chNFe": "43161107364617000135550000000099461000094833",
"tpAmb": "2",
"dhEvento": "2016-11-28T19:06:14-02:00",
"nSeqEvento": "1",
"xCorrecao": "CC-e realizada para teste de integração"
}'
\https://nfe.ns.eti.br/util/generatecce
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| xml | XML gerado a partir do json | somente em status = 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Xml gerado com sucesso",
"xml": "<evento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\" >....</evento>"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Xml gerado com sucesso |
| -2 | Chave de acesso inválida: CHAVE. A chave deve conter 44 caracteres numericos. |
Gerar XML de Inutilização
Através deste endpoint, é possível enviar um json de inutilização que será convertido para um xml sem as informações de assinatura.
URL
Produção: POST https://nfe.ns.eti.br/util/generateinut
Dados de entrada
Os dados de entrada deste método são os mesmos da Inutilização de Numeração na NS NF-e API
| Campo | Descrição | Observação |
|---|---|---|
| X-AUTH-TOKEN | Token de acesso do usuário | |
| cUF | Código da UF do emitente do Documento Fiscal | |
| tpAmb | Tipo do ambiente de inutilização da NF-e: 1 - Produção2 - Homologação | |
| ano | Ano de inutilização da numeração | |
| CNPJ | CNPJ do emitente | |
| serie | Série do NF-e | |
| nNFIni | Número da NF-e inicial a ser inutilizado | |
| nNFFin | Número da NF-e final a ser inutilizado | |
| xJust | Informar a justificativa do pedido de inutilização |
Exemplo de requisição
Requisição de inutilização de NF-e
curl -X POST
\-H "Content-Type: application/json"
\-d '{
"X-AUTH-TOKEN": "SEU_TOKEN",
"cUF": "43",
"tpAmb": "2",
"ano": "16",
"CNPJ": "07364617000135",
"serie": "0",
"nNFIni": "9996",
"nNFFin": "9996",
"xJust": "Inutilizacao realizada para teste de integracao"
}'
\https://nfe.ns.eti.br/util/generateinut
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| motivo | Descrição literal do status de processamento | |
| xml | XML gerado a partir do json | somente status = 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Xml gerado com sucesso",
"xml": "<inutNFe versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\" >....</inutNFe>"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Xml gerado com sucesso |