Utilizando a NS API, este exemplo - criado em PHP - possui funcionalidades para consumir documentos fiscais eletrônicos em geral, como por exemplo:

• NFe;
• CTe;
• NFCe;
• MDFe;
• BPe;

Simplificando todos os projetos utilizados em um único exemplo, deixando mais pratica e facil a integração com a NS API.

Para utilizar as funções de comunicação com a API, você precisa realizar os seguintes passos:

1. Extraia o conteúdo da pasta compactada que você baixou;
2. Copie para sua aplicação a pasta src, na qual contem todos as classes que serão utilizadas;
3. Abra o seu projeto e importe a pasta copiada.

Pronto! Agora, você já pode consumir a NS Suite API através do seu sistema. Todas as funcionalidades de comunicação foram implementadas na classe NSSuite.php.

Para realizar uma emissão completa de uma NFe (utilizada para exemplo), você poderá utilizar a função emitirNFeSincrono da classe NSSuite. Veja abaixo sobre os parâmetros necessários, e um exemplo de chamada do método.

ATENÇÃO: o token também é um parâmetro necessário e você deve, primeiramente, defini-lo na classe NSSuite.php, como pode ver abaixo:

Após ter todos os parâmetros listados acima, você deverá fazer a chamada da função. Veja o código de exemplo abaixo:

  $retorno = $NSSuite->emitirNFeSincrono($conteudo, $tpConteudo, $cnpjEmit, $tpDown, $tpAmb, $caminho, $exibeNaTela);
  echo $retorno;

A função emitirNFeSincrono fará o envio, a consulta e download do documento, utilizando as funções emitirDocumento, consultarStatusProcessamento e downloadDocumentoESalvar, presentes na classe NSSuite.php. Por isso, o retorno será um JSON com os principais campos retornados pelos métodos citados anteriormente. No exemplo abaixo, veja como tratar o retorno da função emitirNFeSincrono:

O JSON retornado pelo método terá os seguintes campos: statusEnvio, statusConsulta, statusDownload, cStat, chNFe, nProt, motivo, nsNRec, erros. Veja o exemplo abaixo:

{
    "statusEnvio": "200",
    "statusConsulta": "200",
    "statusDownload": "200",
    "cStat": "100",
    "chNFe": "43181007364617000135550000000119741004621864",
    "nProt": "143180007036833",
    "motivo": "Autorizado o uso da NF-e",
    "nsNRec": "313022",
    "erros": ""
}

Confira um código para tratamento do retorno, no qual pegará as informações dispostas no JSON de Retorno disponibilizado:

$resposta = $NSSuite->emitirNFeSincrono($conteudo, $tpConteudo, $cnpjEmit, $tpDown, $tpAmb, $caminho, $exibeNaTela);

$statusEnvio = $resposta['statusEnvio'];
$statusConsulta = $resposta['statusConsulta'];
$statusDownload = $resposta['statusDownload'];
$cStat = $resposta['cStat'];
$chNFe = $resposta['chNFe'];
$nProt = $resposta['nProt'];
$motivo = $resposta['motivo'];
$nsNRec = $resposta['nsNRec'];
$erros = $resposta['erros'];

if ($statusEnvio == 200 || $statusEnvio == -6){
    if ($statusConsulta == 200){
        if ($cStat == 100){
            echo $motivo;
            if ($statusDownload != 200){
                echo 'Erro Download';
            }
        }else{
            echo $motivo;
        }
    }else{
        echo $motivo . '<br>' . $erros;
    }
}else{
    echo $motivo . '<br>' . $erros;
}

Utilizando NFe como exemplo para o cancelamento deve-se ter em mente que você deverá usar a função cancelarDocumentoESalvar da classe NSSuite. Veja abaixo sobre os parâmetros necessários, e um exemplo de chamada do método.

ATENÇÃO: o token também é um parâmetro necessário e você deve, primeiramente, defini-lo na classe NSSuite.php, como pode ver abaixo:

Após ter todos os parâmetros listados acima, você deverá fazer a chamada da função. Veja o código de exemplo abaixo:

$NSSuite = new NSSuite;

$cancelarReqNFe = new CancelarReqNFe();
$cancelarReqNFe->chNFe = '43190307364617000135550000000130621004621863';
$cancelarReqNFe->dhEvento='2019-03-15T15:37:14-03:00';
$cancelarReqNFe->nProt = '143190000501923';
$cancelarReqNFe->tpAmb = '2';
$cancelarReqNFe->xJust = 'TESTE DE CANCELAMENTO INTEGRAÇÃO NS';

$down = new DownloadEventoReqNFe();
$down->tpDown = 'XP';
$down->tpEvento= 'CANC';
$down->nSeqEvento = '1';
$down->tpAmb = '2';
$down->chNFe = '43190307364617000135550000000130621004621863';
$retorno = $NSSuite->cancelarDocumentoESalvar('55', $cancelarReqNFe, $down, './Notas', '43190307364617000135550000000130621004621863', true);

A função cancelarDocumentoESalvar fará o cancelamento de qualquer documento que possa ser cancelado e fazendo o download do evento feito, neste caso hipotético, uma NFe, utilizando as funções cancelarDocumento e downloadEventoESalvar, presentes na classe NSSuite.php. Dessa forma, o retorno será um JSON com os principais campos retornados pelos métodos citados anteriormente. No exemplo abaixo, veja o retorno da nossa API em um cancelamento:

{
  "status": 135,
  "motivo": "NF-e cancelada com sucesso",
  "retEvento": {
    "cStat": 135,
    "xMotivo": "Evento registrado e vinculado a NF-e",
    "chNFe": "43190307364617000135550000000130621004621863",
    "dhRegEvento": "2019-03-15T15:37:14-03:00",
    "nProt": "143190000501923"
  }
}

Utilizando NFe como exemplo para a criação de uma carta de correção, deve-se ter em mente que você deverá usar a função corrigirDocumentoESalvar da classe NSSuite. Veja abaixo sobre os parâmetros necessários, e um exemplo de chamada do método.

ATENÇÃO: o token também é um parâmetro necessário e você deve, primeiramente, defini-lo na classe NSSuite.php, como pode ver abaixo:

Após ter todos os parâmetros listados acima, você deverá fazer a chamada da função. Veja o código de exemplo abaixo:

$cceTeste  = new CorrigirReqNFe();
$cceTeste->chNFe = '43190207364617000135550000000129281004621862';
$cceTeste->dhEvento = '2019-03-06T12:00:00-03:00';
$cceTeste->tpAmb = '2';
$cceTeste->nSeqEvento = '1';
$cceTeste->xCorrecao = 'CC-e realizada para teste de integração';

$downTeste = new DownloadEventoReqNFe();
$downTeste->chNFe = '143190207364617000135550000000129281004621862';
$downTeste->tpAmb = '2';
$downTeste->nSeqEvento = '1';
$downTeste->tpDown = 'XP';
$downTeste->tpEvento = 'CCE';

$retorno = NSSuite->corrigirDocumentoESalvar('55', $cceTeste, $downTeste, './Notas', '43190207364617000135550000000129281004621862', '1', true);

A função corrigirDocumentoESalvar irá vincular um CCe (carta de correção) ao projeto selecionado, neste caso hipotético, à uma NFe, utilizando as funções corrigirDocumento e downloadEventoESalvar, presentes na classe NSSuite.php. Dessa forma, o retorno será um JSON com os principais campos retornados pelos métodos citados anteriormente. No exemplo abaixo, veja o retorno da nossa API em uma CCe:

{
  "status": 200,
  "motivo": "CC-e vinculada com sucesso",
  "retEvento": {
    "cStat": 135,
    "xMotivo": "Evento registrado e vinculado a NF-e",
    "chNFe": "43190207364617000135550000000129281004621862",
    "dhRegEvento": "2019-03-06T12:00:50-03:00",
    "nProt": "143190000330112"
  }
}

Utilizando NFe como exemplo para a inutilização de numeração, deverá ser utilizada a função inutilizarNumeracaoESalvar da classe NSSuite. Veja abaixo sobre os parâmetros necessários, e um exemplo de chamada do método.

ATENÇÃO: o token também é um parâmetro necessário e você deve, primeiramente, defini-lo na classe NSSuite.php, como pode ver abaixo:

Após ter todos os parâmetros listados acima, você deverá fazer a chamada da função. Veja o código de exemplo abaixo:

  $NSSuite = new NSSuite;
  $inutilizarReq = new InutilizarReqNFe();
  $inutilizarReq->cUF = '43';
  $inutilizarReq->CNPJ = '07364617000135';
  $inutilizarReq->tpAmb = '2';
  $inutilizarReq->ano = '20';
  $inutilizarReq->serie = '20';
  $inutilizarReq->nNFIni = '9996'
  $inutilizarReq->nNFFin = '9996'
  $inutilizarReq->xJust = 'Inutilizacao realizada para teste de integracao';

  $caminho = '.\Notas';
  $retorno = $NSSuite->inutilizarNumeracaoESalvar('55', $inutilizarReq, $caminho);

A função inutilizarNumeracaoESalvar irá inutilizar a numeração do documento, neste caso hipotético, à uma NFe, presente na classe NSSuite.php. Dessa forma, o retorno será um JSON com os principais campos retornados pelos métodos citados anteriormente. No exemplo abaixo, veja o retorno da nossa API de um inutilização de numeração:

        {
              "status": 200,
              "motivo": "Consulta realizada com sucesso",
              "retornoInutNFe": {
                    "cStat": "102",
                    "xMotivo": "Inutilizacao de numero homologado",
                    "chave": "43111111111111111111111111111111111111111",
                    "tpAmb": 2,
                    "dhRecbto": "2016-12-07T17:10:52-02:00",
                    "nProt": "143160001541466",
                    "xmlInut": "<?xml version=\"1.0\" encoding=\"utf-8\"?><ProcInutNFe versao=\"3.10\" xmlns=\"http://www.portalfiscal.inf.br/nfe\">...</ProcInutNFe>"
              }
        }

| Obrigado pela atenção!