Enviar uma NFS-e API 2.0
Serviço destinado a enviar uma NFS-e para uma prefeitura.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação da nota de serviço no Tiny |
formato | string | obrigatório | Formato do retorno (json ou xml) |
enviarEmail | string | obrigatório | Flag para enviar e-mail para o cliente cadastrado na nota de serviço (somente se for autorizada). Valores são: "S" ou "N" |
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | - | - | obrigatório | Elemento raiz do retorno |
retorno.status_processamento | int | - | obrigatório | Conforme tabela "Status de Processamento" |
retorno.status | string | - | obrigatório | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.codigo_erro (1) | int | - | condicional | Conforme tabela "Códigos de erro" |
retorno.erros[ ] (1) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | string | condicional | Mensagem contendo a descrição do erro |
retorno.nota_servico (2) | object | - | condicional | Nodo utilizado para representar uma nota fiscal. |
retorno.nota_servico.id | int | - | obrigatório | Número de identificação da nota de serviço no Tiny |
retorno.nota_servico.situacao (4) | int | - | obrigatório | Situação da nota de serviço |
retorno.nota_servico.erros[ ] (5) | list | - | condicional [0..n] | Contém a lista dos erros encontrados no envio da nota de serviço para a prefeitura. |
retorno.nota_servico.erros[ ].erro (5) | string | string | condicional | Estrutura contendo o erro na nota de serviço |
retorno.nota_servico.erros[ ].erro.codigo (5) | string | string | condicional | Código do erro |
retorno.nota_servico.erros[ ].erro.mensagem (5) | string | string | condicional | Descrição do erro |
retorno.nota_servico.erros[ ].erro.correcao (5) | string | string | condicional | Correção do erro |
retorno.nota_servico.numero_lote (6) | string | 50 | condicional | Número do lote gerado no processamento da NFS-e |
retorno.nota_servico.protocolo (6) | string | 50 | condicional | Protocolo gerado no processamento da NFS-e |
retorno.nota_servico.codigo_verificacao (6) | string | 100 | condicional | Código de verificação da NFS-e |
retorno.nota_servico.numero_nfse (6) | string | 20 | condicional | Número da NFS-e gerada |
retorno.nota_servico.link_impressao (6) | string | 200 | condicional | Link para impressão da NFS-e no sistema da prefeitura |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Pode ser: 1 (Pendente), 2 (Autorizada), 3 (Cancelada), 4 (Lote não processado) e 5 (Processado com erro).
(5) - Esses campos só serão informados caso o campo situacao seja 5 (Processado com erro).
(6) - Esses campos só serão informados caso a situação seja 2 (Autorizada) ou 4 (Lote não processado). O preenchimento desses campos depende do retorno de cada prefeitura.
Observações:
- Somente é possível utilizar essa API com certificado digital armazenado em nossos servidores.
- Essa API pode demorar, pois depende do processamento das prefeituras.
- As notas serão enviadas no ambiente que está selecionado em "Configurações -> Configuração da Nota Fiscal Eletrônica de Serviços (NFSe) -> Tipo de ambiente" (se a prefeitura permitir essa opção).
- Caso o retorno tenha a situação 4 (Lote não processado), use a API "Consultar NFS-e" para verificar o andamento do envio dessa nota de serviço.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.servico.enviar.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$data = "token=$token&id=$id&formato=XML&enviarEmail=N";
enviarREST($url, $data);
function enviarREST($url, $data, $optional_headers = null) {
$params = array('http' => array(
'method' => 'POST',
'content' => $data
));
if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}
$ctx = stream_context_create($params);
$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problema com $url, $php_errormsg");
}
$response = @stream_get_contents($fp);
if ($response === false) {
throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
}
return $response;
}
$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;
$result = $client->call("enviarNotaServicoService", array('token' => 'xxxxx','id'=>'xxxxx','formato'=>'XML','enviarEmail'=>'N'));
$res = array();
if ($client->fault) {
$retorno = $result['faultstring'];
} else {
$err = $client->getError();
if ($err) {
$retorno = $err;
} else {
$retorno = $result;
}
}
Exemplos de retorno da API
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>1</status_processamento>
<status>Erro</status>
<codigo_erro>2</codigo_erro>
<erros>
<erro>token invalido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>2</status_processamento>
<status>Erro</status>
<codigo_erro>32</codigo_erro>
<erros>
<erro>
<mensagem>Nota de serviço não localizada</mensagem>
</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<nota_servico>
<id>439322</id>
<situacao>5</situacao>
<erros>
<erro>
<codigo>E45</codigo>
<mensagem>CNPJ não encontrado na base de dados</mensagem>
<correcao>Confira o numero do CNPJ informado. Caso esteja correto, o prestador não está inscrito no município.</correcao>
</erro>
</erros>
</nota_servico>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<nota_servico>
<id>41442</id>
<situacao>5</situacao>
<numero_lote>333</numero_lote>
<protocolo>11231231333312312</protocolo>
<codigo_verificacao>XF23</codigo_verificacao>
<numero_nfse>982</numero_nfse>
<link_impressao>https://www.prefeitura.com/982</link_impressao>
</nota_servico>
</retorno>