Obter Nota de Serviço API 2.0
Serviço destinado a obter os dados de uma Nota Fiscal de Serviço.
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) |
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | object | - | 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 | - | condicional | Mensagem contendo a descrição do erro |
retorno.nota_fiscal (2) | object | - | condicional | Elemento utilizado para representar uma nota de serviço |
retorno.nota_fiscal.id | int | - | obrigatório | Número de identificação da nota de servico no Tiny |
retorno.nota_fiscal.serie | int | - | obrigatório | Número de série da nota de serviço |
retorno.nota_fiscal.numero | int | - | opcional | Número da nota serviço |
retorno.nota_fiscal.numeroRPS | int | - | opcional | Número do RPS |
retorno.nota_fiscal.codigo_verificacao | string | 60 | opcional | Código de verificação de nota junto a prefeitura |
retorno.nota_fiscal.data_emissao (4) | date | 10 | obrigatório | Data de emissão da nota de serviço |
retorno.nota_fiscal.cliente | object | 10 | obrigatório | Elemento utilizado para representar o cliente |
retorno.nota_fiscal.cliente.nome | string | 30 | obrigatório | Nome do cliente |
retorno.nota_fiscal.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.nota_fiscal.cliente.cpf_cnpj | string | 18 | opcional | CPF ou CNPJ do cliente |
retorno.nota_fiscal.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
retorno.nota_fiscal.cliente.endereco | string | 50 | opcional | Endereço do cliente |
retorno.nota_fiscal.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
retorno.nota_fiscal.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
retorno.nota_fiscal.cliente.bairro | string | 30 | opcional | Bairro do cliente |
retorno.nota_fiscal.cliente.cep | string | 10 | opcional | Cep do cliente |
retorno.nota_fiscal.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
retorno.nota_fiscal.cliente.uf | string | 30 | opcional | UF do cliente |
retorno.nota_fiscal.cliente.fone | string | 40 | opcional | Telefone do cliente |
retorno.nota_fiscal.cliente.email | string | 40 | opcional | E-mail do cliente |
retorno.nota_fiscal.servico | object | obrigatório | Elemento utilizado para representar o serviço | |
retorno.nota_fiscal.servico.descricao | string | 300 | obrigatório | Descrição do serviço |
retorno.nota_fiscal.servico.valor_servico (5) | decimal | - | obrigatório | Valor do serviço |
retorno.nota_fiscal.servico.codigo_lista_servico | string | 10 | opcional | Código de acordo com a lista de serviços |
retorno.nota_fiscal.descontar_ir | string | - | obrigatório | Descontar o valor do IR do total da nota (S/N) |
retorno.nota_fiscal.percentual_ir (5) | decimal | - | obrigatório | Percentual do IR |
retorno.nota_fiscal.valor_ir (5) | decimal | - | obrigatório | Valor do IR |
retorno.nota_fiscal.texto_ir | string | 150 | obrigatório | Texto do IR |
retorno.nota_fiscal.percentual_iss (5) | decimal | - | obrigatório | Percentual do ISS |
retorno.nota_fiscal.valor_iss (5) | decimal | - | obrigatório | Valor do ISS |
retorno.nota_fiscal.descontar_iss_total | string | 1 | obrigatório | Descontar ISS do total da nota (S/N) |
retorno.nota_fiscal.texto_confins | string | 30 | opcional | Texto com a descrição do Cofins |
retorno.nota_fiscal.valor_confins (5) | decimal | - | opcional | Valor do Cofins |
retorno.nota_fiscal.texto_pis | string | 30 | opcional | Texto com a descrição do PIS |
retorno.nota_fiscal.valor_pis (5) | decimal | - | opcional | Valor do PIS |
retorno.nota_fiscal.texto_cs | string | 30 | opcional | Texto com a descrição da Contribuição Social |
retorno.nota_fiscal.valor_cs (5) | decimal | - | opcional | Valor da Contribuição Social |
retorno.nota_fiscal.total_nota (5) | decimal | - | obrigatório | Valor total da nota |
retorno.nota_fiscal.forma_pagamento | string | 30 | obrigatório | Código conforme tabela de Formas de pagamento |
retorno.nota_fiscal.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
retorno.nota_fiscal.parcelas[ ] | list | opcional | Lista de parcelas da nota | |
retorno.nota_fiscal.parcelas[ ].parcela | object | opcional | Elemento utilizado para representar uma parcela | |
retorno.nota_fiscal.parcelas[ ].parcela.dias | int | 20 | opcional | Dias de vencimento da parcela |
retorno.nota_fiscal.parcelas[ ].parcela.data (4) | date | 10 | opcional | Data de vencimento da parcela |
retorno.nota_fiscal.parcelas[ ].parcela.valor (5) | decimal | - | opcional | Valor da parcela |
retorno.nota_fiscal.parcelas[ ].parcela.obs | string | 100 | opcional | Observação da parcela |
retorno.nota_fiscal.parcelas[ ].parcela.forma_pagamento | string | 30 | obrigatório | Código conforme tabela de Formas de pagamento |
retorno.nota_fiscal.parcelas[ ].parcela.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
retorno.nota_fiscal.id_vendedor | int | - | opcional | Número de identificação do Vendedor associado a nota fiscal. |
retorno.nota_fiscal.nome_vendedor | string | 50 | opcional | Nome do Vendedor associado a nota fiscal. |
retorno.nota_fiscal.percentual_comissao (5) | decimal | - | opcional | Percentual de comissão do vendedor |
retorno.nota_fiscal.valor_comissao (5) | decimal | - | opcional | Valor de comissão do vendedor |
retorno.nota_fiscal.situacao | int | - | obrigatório | Código conforme tabela de Situações das Notas de Serviço |
retorno.nota_fiscal.descricao_situacao | string | 30 | obrigatório | Descrição conforme tabela de Situações das Notas de Serviço |
retorno.nota_fiscal.condicoes | string | 30 | opcional | Texto contendo as condições da nota |
retorno.nota_fiscal.crt | string | 1 | opcional | Código de regime tributário |
retorno.nota_fiscal.link_impressao | 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) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.servico.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$data = "token=$token&id=$id&formato=XML";
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("obterNotaServicoXMLService", array('token' => 'xxxxx','id'=>'xxxxx','formato'=>'XML'));
$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>21</codigo_erro>
<erros>
<erro>A consulta retornou mais registros que o permitido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<nota_fiscal>
<id>123456</id>
<numero>123</numero>
<numeroRPS>12</numeroRPS>
<data_emissao>14/02/2013</data_emissao>
<cliente>
<codigo>1235</codigo>
<nome>Contato Teste 2</nome>
<tipo_pessoa>F</tipo_pessoa>
<cpf_cnpj>22755777850</cpf_cnpj>
<ie/>
<rg>1234567890</rg>
<endereco>Rua Teste</endereco>
<numero>123</numero>
<complemento>sala 2</complemento>
<bairro>Teste</bairro>
<cep>95700000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>5430553808</fone>
</cliente>
<servico>
<descricao>Servico Teste 1</descricao>
<unidade>UN</unidade>
<valor_servico>600.30</valor_servico>
<codigo_lista_servico>1.02.01</codigo_lista_servico>
</servico>
<percentual_ir>2.5</percentual_ir>
<valor_ir>12.51</valor_ir>
<texto_ir>( - ) IRenda Fonte 2,5%</texto_ir>
<percentual_iss>3</percentual_iss>
<valor_iss>15.01</valor_iss>
<descontar_iss_total>N</descontar_iss_total>
<texto_confins/>
<valor_confins>0</valor_confins>
<texto_pis/>
<valor_pis>0</valor_pis>
<texto_cs/>
<valor_cs>0</valor_cs>
<total_nota>490.29</total_nota>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco</meio_pagamento>
<parcelas>
<parcela>
<dias>30</dias>
<data>16/03/2013</data>
<valor>200.10</valor>
<obs>Obs Parcela 1</obs>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco</meio_pagamento>
</parcela>
<parcela>
<dias>60</dias>
<data>15/04/2013</data>
<valor>200.10</valor>
<obs>Obs Parcela 2</obs>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco</meio_pagamento>
</parcela>
<parcela>
<dias>90</dias>
<data>15/05/2013</data>
<valor>200.10</valor>
<obs>Obs Parcela 3</obs>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco</meio_pagamento>
</parcela>
</parcelas>
<nome_vendedor>Vendedor Teste</nome_vendedor>
<percentual_comissao>5.00</percentual_comissao>
<valor_comissao>25.02</valor_comissao>
<situacao>1</situacao>
<situacao>Pendente</situacao>
<condicoes>123</condicoes>
<crt>0</crt>
</nota_fiscal>
</retorno>