Obter Nota Fiscal API 2.0
Serviço destinado a obter os dados de uma Nota Fiscal.
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 fiscal no Tiny |
formato | string | obrigatório | Formato do retorno (json ou xml) |
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 | - | condicional | Mensagem contendo a descrição do erro |
retorno.nota_fiscal (2) | object | - | condicional | Nodo utilizado para representar uma nota fiscal. |
retorno.nota_fiscal.id | int | - | condicional | Número de identificação da nota fiscal no Tiny |
retorno.nota_fiscal.tipo_nota | string | 1 | condicional | Código conforme Tabela de tipos da nota fiscal |
retorno.nota_fiscal.natureza_operacao | string | 80 | condicional | Natureza de operação da nota fiscal |
retorno.nota_fiscal.regime_tributario | int | - | condicional | Código conforme Tabela de regime tributário da nota fiscal |
retorno.nota_fiscal.finalidade | int | i | condicional | Código conforme Tabela de finalidade da nota fiscal |
retorno.nota_fiscal.serie | int | - | condicional | Número de série da nota fiscal |
retorno.nota_fiscal.numero | int | - | condicional | Número da nota fiscal |
retorno.nota_fiscal.numero_ecommerce | string | 50 | condicional | Número do pedido no ecommerce(ou sistema) |
retorno.nota_fiscal.data_emissao (4) | date | 10 | opcional | Data de emissão da nota fiscal |
retorno.nota_fiscal.data_saida (4) | date | 10 | opcional | Data de saída da nota fiscal |
retorno.nota_fiscal.hora_saida (6) | string | 10 | opcional | Hora de saída da nota fiscal |
retorno.nota_fiscal.cliente | object | 10 | opcional | 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.endereco_entrega | object | opcional | Elemento utilizado para representar o endereço de entrega (se não houver, será retornado o mesmo de cobrança). | |
retorno.nota_fiscal.endereco_entrega.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.nota_fiscal.endereco_entrega.cpf_cnpj | string | 18 | opcional | CPF ou CNPJ de entrega |
retorno.nota_fiscal.endereco_entrega.endereco | string | 50 | opcional | Endereço de entrega |
retorno.nota_fiscal.endereco_entrega.numero | string | 10 | opcional | Número do endereço de entrega |
retorno.nota_fiscal.endereco_entrega.complemento | string | 50 | opcional | Complemento do endereço de entrega |
retorno.nota_fiscal.endereco_entrega.bairro | string | 30 | opcional | Bairro de entrega |
retorno.nota_fiscal.endereco_entrega.cep | string | 10 | opcional | Cep de entrega |
retorno.nota_fiscal.endereco_entrega.cidade | string | 30 | opcional | Nome da cidade de entrega conforme a Tabela de Cidades |
retorno.nota_fiscal.endereco_entrega.uf | string | 30 | opcional | UF de entrega |
retorno.nota_fiscal.endereco_entrega.fone | string | 40 | opcional | Telefone de entrega |
retorno.nota_fiscal.endereco_entrega.nome_destinatario | string | 60 | opcional | Nome do destinatário da entrega |
retorno.nota_fiscal.endereco_entrega.ie | string | 18 | opcional | Inscrição estadual de entrega |
retorno.nota_fiscal.itens[ ] | list | obrigatório | Lista de itens da nota fiscal | |
retorno.nota_fiscal.itens[ ].item | object | obrigatório | Elemento utilizado para representar um item da nota fiscal | |
retorno.nota_fiscal.itens[ ].item.id_produto | int | - | opcional | Número de identificação do produto no Tiny |
retorno.nota_fiscal.itens[ ].item.codigo | string | 60 | opcional | Código do item |
retorno.nota_fiscal.itens[ ].item.descricao | string | 120 | obrigatório | Descrição do item |
retorno.nota_fiscal.itens[ ].item.unidade | string | 3 | obrigatório | Unidade do item |
retorno.nota_fiscal.itens[ ].item.ncm | string | 10 | obrigatório | NCM do item |
retorno.nota_fiscal.itens[ ].item.quantidade (5) | decimal | - | obrigatório | Quantidade do item |
retorno.nota_fiscal.itens[ ].item.valor_unitario (5) | decimal | - | obrigatório | Valor unitário do item |
retorno.nota_fiscal.itens[ ].item.valor_total (5) | decimal | - | obrigatório | Valor total do item |
retorno.nota_fiscal.itens[ ].item.cfop | string | 4 | obrigatório | CFOP do item |
retorno.nota_fiscal.itens[ ].item.natureza | string | 80 | obrigatório | Natureza de operação do item |
retorno.nota_fiscal.base_icms (5) | decimal | opcional | Valor da base do ICMS da nota fiscal | |
retorno.nota_fiscal.valor_icms (5) | decimal | opcional | Valor do ICMS da nota fiscal | |
retorno.nota_fiscal.base_icms_st (5) | decimal | opcional | Valor da base do ICMS ST da nota fiscal | |
retorno.nota_fiscal.valor_icms_st (5) | decimal | opcional | Valor do ICMS ST da nota fiscal | |
retorno.nota_fiscal.valor_servicos (5) | decimal | opcional | Valor dos serviços da nota fiscal | |
retorno.nota_fiscal.valor_produtos (5) | decimal | opcional | Valor dos produtos da nota fiscal | |
retorno.nota_fiscal.valor_frete (5) | decimal | opcional | Valor do frete da nota fiscal | |
retorno.nota_fiscal.valor_seguro (5) | decimal | opcional | Valor do seguro da nota fiscal | |
retorno.nota_fiscal.valor_outras (5) | decimal | opcional | Valor das outras despesas da nota fiscal | |
retorno.nota_fiscal.valor_ipi (5) | decimal | opcional | Valor do IPI da nota fiscal | |
retorno.nota_fiscal.valor_issqn (5) | decimal | opcional | Valor do ISSQN da nota fiscal | |
retorno.nota_fiscal.valor_nota (5) | decimal | opcional | Valor da Nota Fiscal | |
retorno.nota_fiscal.valor_desconto (5) | decimal | opcional | Valor do desconto da Nota Fiscal | |
retorno.nota_fiscal.valor_faturado (5) | decimal | opcional | Valor total faturado da Nota Fiscal | |
retorno.nota_fiscal.frete_por_conta | string | 1 | opcional | "R"-Remetente, "D"-Destinatário |
retorno.nota_fiscal.transportador | object | 10 | opcional | Elemento utilizado para representar o transportador |
retorno.nota_fiscal.transportador.nome | string | 30 | obrigatório | Nome do transportador |
retorno.nota_fiscal.transportador.cpf_cnpj | string | 18 | opcional | CPF ou CNPJ do transportador |
retorno.nota_fiscal.transportador.ie | string | 18 | opcional | Inscrição estadual do transportador |
retorno.nota_fiscal.transportador.endereco | string | 50 | opcional | Endereço do transportador |
retorno.nota_fiscal.transportador.cidade | string | 30 | opcional | Nome da cidade do transportador conforme a Tabela de Cidades |
retorno.nota_fiscal.transportador.uf | string | 30 | opcional | UF do transportador |
retorno.nota_fiscal.placa | string | 8 | opcional | Placa do veículo transportador |
retorno.nota_fiscal.uf_placa | string | 8 | opcional | UF da placa do veículo transportador |
retorno.nota_fiscal.quantidade_volumes | int | opcional | Quantidade de volumes da Nota Fiscal | |
retorno.nota_fiscal.especie_volumes | string | 20 | opcional | Espécie dos volumes da Nota Fiscal |
retorno.nota_fiscal.marca_volumes | string | 20 | opcional | Marca dos volumes da Nota Fiscal |
retorno.nota_fiscal.numero_volumes | string | 10 | opcional | Número dos volumes da Nota Fiscal |
retorno.nota_fiscal.peso_bruto (5) | decimal | opcional | Peso Bruto da Nota Fiscal | |
retorno.nota_fiscal.peso_liquido (5) | decimal | opcional | Peso Líquido da Nota Fiscal | |
retorno.nota_fiscal.codigo_rastreamento | string | 20 | condicional | Código de rastreamento da Nota Fiscal |
retorno.nota_fiscal.url_rastreamento | string | 120 | condicional | URL de rastreamento da Nota Fiscal |
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.condicao_pagamento | string | 30 | opcional | Descrição da condição de pagamento |
retorno.nota_fiscal.parcelas[ ] | list | opcional | Lista de parcelas da Nota Fiscal | |
retorno.nota_fiscal.parcelas[ ].parcela | object | opcional | Elemento utilizado para representar uma parcela da Nota Fiscal | |
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.situacao | int | - | opcional | Código conforme Tabela de situações da nota fiscal |
retorno.nota_fiscal.descricao_situacao | string | 30 | opcional | Descrição conforme Tabela de situações da nota fiscal |
retorno.nota_fiscal.obs | string | 100 | opcional | Observação da Nota Fiscal |
retorno.nota_fiscal.chave_acesso | string | 100 | opcional | Chave de acesso da Nota Fiscal |
(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".
(6) - Estes campos utilizam o formato hh:mm:ss, exemplo "10:45:01".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.fiscal.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("obterNotaFiscalService", 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>39995226</id>
<tipo_nota>N</tipo_nota>
<natureza_operacao>Venda de mercadorias</natureza_operacao>
<regime_tributario>3</regime_tributario>
<finalidade>1</finalidade>
<serie>1</serie>
<numero>000148</numero>
<numero_ecommerce/>
<data_emissao>11/01/2018</data_emissao>
<data_saida>11/01/2018</data_saida>
<hora_saida/>
<cliente>
<nome>henrique teste 1</nome>
<tipo_pessoa>F</tipo_pessoa>
<cpf_cnpj>182.334.983-86</cpf_cnpj>
<ie/>
<endereco>Rua teste</endereco>
<numero>4</numero>
<complemento>casa</complemento>
<bairro>Centro</bairro>
<cep>95.700-000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>(54) 1234-1234</fone>
<email>henrique1@tiny.com.br</email>
</cliente>
<endereco_entrega>
<tipo_pessoa>F</tipo_pessoa>
<cpf_cnpj>182.334.983-86</cpf_cnpj>
<endereco>Rua teste</endereco>
<numero>4</numero>
<complemento>casa</complemento>
<bairro>Centro</bairro>
<cep>95.700-000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>(54) 1234-1234</fone>
<nome_destinatario>henrique teste 1</nome_destinatario>
</endereco_entrega>
<itens>
<item>
<id_produto>439687978</id_produto>
<codigo>cam-hnrq-var-10-1</codigo>
<descricao>camisa hnrq var 10 - G - Branco</descricao>
<unidade>UN</unidade>
<ncm>1001.10.10</ncm>
<quantidade>3.00</quantidade>
<valor_unitario>50.78</valor_unitario>
<valor_total>152.34</valor_total>
<cfop>6101</cfop>
<natureza>Venda de mercadorias</natureza>
</item>
</itens>
<base_icms>0.00</base_icms>
<valor_icms>0.00</valor_icms>
<base_icms_st>0.00</base_icms_st>
<valor_icms_st>0.00</valor_icms_st>
<valor_servicos>0.00</valor_servicos>
<valor_produtos>152.34</valor_produtos>
<valor_frete>8.15</valor_frete>
<valor_seguro>5.26</valor_seguro>
<valor_outras>12.01</valor_outras>
<valor_ipi>0.00</valor_ipi>
<valor_issqn>0.00</valor_issqn>
<valor_nota>165.51</valor_nota>
<valor_desconto>12.25</valor_desconto>
<valor_faturado>165.51</valor_faturado>
<frete_por_conta>R</frete_por_conta>
<transportador>
<nome/>
<cpf_cnpj/>
<ie/>
<endereco/>
<cidade/>
<uf> </uf>
</transportador>
<placa/>
<uf_placa> </uf_placa>
<quantidade_volumes>0</quantidade_volumes>
<especie_volumes>XX</especie_volumes>
<marca_volumes/>
<numero_volumes/>
<peso_bruto>13.50</peso_bruto>
<peso_liquido>12.60</peso_liquido>
<codigo_rastreamento>EE201798383BR</codigo_rastreamento>
<url_rastreamento>http://www.issoehumaurl.com</url_rastreamento>
<condicao_pagamento>30 60 90</condicao_pagamento>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco X</meio_pagamento>
<parcelas>
<parcela>
<dias>30</dias>
<data>10/02/2018</data>
<valor>55.17</valor>
<obs/>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco X</meio_pagamento>
</parcela>
<parcela>
<dias>60</dias>
<data>12/03/2018</data>
<valor>55.17</valor>
<obs/>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco X</meio_pagamento>
</parcela>
<parcela>
<dias>90</dias>
<data>11/04/2018</data>
<valor>55.17</valor>
<obs/>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco X</meio_pagamento>
</parcela>
</parcelas>
<id_vendedor>0</id_vendedor>
<nome_vendedor/>
<situacao>1</situacao>
<descricao_situacao>Pendente</descricao_situacao>
<obs> Tributos aproximados: R$ 20,49 (Federal) e R$ 6,06 (Municipal). Fonte: IBPT A5G7R1</obs>
</nota_fiscal>
</retorno>