NSSuiteClientPHP

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.

Primeiros passos:

Integrando ao sistema:

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

Extraia o conteúdo da pasta compactada que você baixou;
Copie para sua aplicação a pasta src, na qual contem todos as classes que serão utilizadas;
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.

Emissão Sincrona:

Realizando uma Emissão Sincrona:

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.

Parâmetros:

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:

Parametros	Descrição
conteudo	Conteúdo de emissão do documento.
tpConteudo	Tipo de conteúdo que está sendo enviado. Valores possíveis: json, xml, txt
CNPJ	CNPJ do emitente do documento.
tpDown	Tipo de arquivos a serem baixados.Valores possíveis: X - XML J - JSON P - PDF XP - XML e PDF JP - JSON e PDF
tpAmb	Ambiente onde foi autorizado o documento.Valores possíveis: 1 - produção 2 - homologação
caminho	Caminho onde devem ser salvos os documentos baixados.
exibeNaTela	Se for baixado, exibir o PDF na tela após a autorização.Valores possíveis: True - será exibido False - não será exibido

Exemplo de chamada:

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:

Exemplo de tratamento de retorno:

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

Cancelamento de Documento:

Realizando um Cancelamento:

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.

Parâmetros:

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:

Parametros	Descrição
modelo	Conteúdo de emissão do documento. "63" (BPe); "57" (CTe); "67" (CTeOS); "58" (MDFe); "65" (NFCe); "55" (NFe);
CancelarReq	JSON contendo as informações de uma requisição de cancelamento de documento
DownloadEventoReq	JSON contendo as informações de uma requisição de Download de Evento
caminho	Caminho onde devem ser salvos os documentos baixados.
chave	Ambiente onde foi autorizado o documento.Valores possíveis: 1 - produção 2 - homologação
exibeNaTela	Se for baixado, exibir o PDF na tela após a autorização.Valores possíveis: True - será exibido False - não será exibido

Exemplo de chamada:

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:

Exemplo de retorno de 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"
  }
}

Carta de Correção(CC):

Realizando uma Correção de Documento:

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.

Parâmetros:

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

Parametros	Descrição
modelo	Conteúdo de emissão do documento. "63" (BPe); "57" (CTe); "67" (CTeOS); "58" (MDFe); "65" (NFCe); "55" (NFe);
CorrigirReq	JSON contendo as informações de uma requisição de carta de correção
DownloadEventoReq	JSON contendo as informações de uma requisição de Download de Evento
caminho	Caminho onde devem ser salvos os documentos baixados.
chave	Ambiente onde foi autorizado o documento.Valores possíveis: 1 - produção 2 - homologação
nSeqEvento	Número sequencial do evento
exibeNaTela	Se for baixado, exibir o PDF na tela após a autorização.Valores possíveis: True - será exibido False - não será exibido

Exemplo de chamada:

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:

Exempo de retorno de correção de documento:

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

| Obrigado pela atenção!

Name		Name	Last commit message	Last commit date
Latest commit History 18 Commits
src		src
README.md		README.md
index.php		index.php

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

NSSuiteClientPHP

Primeiros passos:

Integrando ao sistema:

Emissão Sincrona:

Realizando uma Emissão Sincrona:

Parâmetros:

Exemplo de chamada:

Exemplo de tratamento de retorno:

Cancelamento de Documento:

Realizando um Cancelamento:

Parâmetros:

Exemplo de chamada:

Exemplo de retorno de cancelamento:

Carta de Correção(CC):

Realizando uma Correção de Documento:

Parâmetros:

Exemplo de chamada:

Exempo de retorno de correção de documento:

About

Releases

Packages

Languages

MaxFerraz/NSSuiteClientPHP

Folders and files

Latest commit

History

Repository files navigation

NSSuiteClientPHP

Primeiros passos:

Integrando ao sistema:

Emissão Sincrona:

Realizando uma Emissão Sincrona:

Parâmetros:

Exemplo de chamada:

Exemplo de tratamento de retorno:

Cancelamento de Documento:

Realizando um Cancelamento:

Parâmetros:

Exemplo de chamada:

Exemplo de retorno de cancelamento:

Carta de Correção(CC):

Realizando uma Correção de Documento:

Parâmetros:

Exemplo de chamada:

Exempo de retorno de correção de documento:

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages