Você está usando um navegador que não é suportado pelo Tiny. Saiba mais

Obter Nota Fiscal API 2.0

Serviço destinado a obter os dados de uma Nota Fiscal.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação da nota fiscal no Tiny
formatostringobrigatórioFormato do retorno (json)
ElementoTipoTamanhoOcorrênciaDescrição
retorno--obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.nota_fiscal (2)object-condicionalNodo utilizado para representar uma nota fiscal.
retorno.nota_fiscal.idint-condicionalNúmero de identificação da nota fiscal no Tiny
retorno.nota_fiscal.tipo_notastring1condicionalCódigo conforme Tabela de tipos da nota fiscal
retorno.nota_fiscal.natureza_operacaostring80condicionalNatureza de operação da nota fiscal
retorno.nota_fiscal.regime_tributarioint-condicionalCódigo conforme Tabela de regime tributário da nota fiscal
retorno.nota_fiscal.finalidadeinticondicionalCódigo conforme Tabela de finalidade da nota fiscal
retorno.nota_fiscal.serieint-condicionalNúmero de série da nota fiscal
retorno.nota_fiscal.numeroint-condicionalNúmero da nota fiscal
retorno.nota_fiscal.numero_ecommercestring50condicionalNúmero do pedido no ecommerce(ou sistema)
retorno.nota_fiscal.data_emissao (4)date10opcionalData de emissão da nota fiscal
retorno.nota_fiscal.data_saida (4)date10opcionalData de saída da nota fiscal
retorno.nota_fiscal.hora_saida (6)string10opcionalHora de saída da nota fiscal
retorno.nota_fiscal.cliente object10opcionalElemento utilizado para representar o cliente
retorno.nota_fiscal.cliente.nomestring30obrigatórioNome do cliente
retorno.nota_fiscal.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.nota_fiscal.cliente.cpf_cnpjstring18opcionalCPF ou CNPJ do cliente
retorno.nota_fiscal.cliente.iestring18opcionalInscrição estadual do cliente
retorno.nota_fiscal.cliente.enderecostring50opcionalEndereço do cliente
retorno.nota_fiscal.cliente.numerostring10opcionalNúmero do endereço do cliente
retorno.nota_fiscal.cliente.complementostring50opcionalComplemento do endereço do cliente
retorno.nota_fiscal.cliente.bairrostring30opcionalBairro do cliente
retorno.nota_fiscal.cliente.cepstring10opcionalCep do cliente
retorno.nota_fiscal.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
retorno.nota_fiscal.cliente.ufstring30opcionalUF do cliente
retorno.nota_fiscal.cliente.fonestring40opcionalTelefone do cliente
retorno.nota_fiscal.cliente.emailstring40opcionalE-mail do cliente
retorno.nota_fiscal.endereco_entregaobjectopcionalElemento 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_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.nota_fiscal.endereco_entrega.cpf_cnpj string18opcionalCPF ou CNPJ de entrega
retorno.nota_fiscal.endereco_entrega.enderecostring50opcionalEndereço de entrega
retorno.nota_fiscal.endereco_entrega.numerostring10opcionalNúmero do endereço de entrega
retorno.nota_fiscal.endereco_entrega.complementostring50opcionalComplemento do endereço de entrega
retorno.nota_fiscal.endereco_entrega.bairrostring30opcionalBairro de entrega
retorno.nota_fiscal.endereco_entrega.cepstring10opcionalCep de entrega
retorno.nota_fiscal.endereco_entrega.cidadestring30opcionalNome da cidade de entrega conforme a Tabela de Cidades
retorno.nota_fiscal.endereco_entrega.ufstring30opcionalUF de entrega
retorno.nota_fiscal.endereco_entrega.fonestring40opcionalTelefone de entrega
retorno.nota_fiscal.endereco_entrega.nome_destinatariostring60opcionalNome do destinatário da entrega
retorno.nota_fiscal.endereco_entrega.iestring18opcionalInscrição estadual de entrega
retorno.nota_fiscal.itens[ ]listobrigatórioLista de itens da nota fiscal
retorno.nota_fiscal.itens[ ].itemobjectobrigatórioElemento utilizado para representar um item da nota fiscal
retorno.nota_fiscal.itens[ ].item.id_produtoint-opcionalNúmero de identificação do produto no Tiny
retorno.nota_fiscal.itens[ ].item.codigostring60opcionalCódigo do item
retorno.nota_fiscal.itens[ ].item.descricaostring120obrigatórioDescrição do item
retorno.nota_fiscal.itens[ ].item.unidadestring3obrigatórioUnidade do item
retorno.nota_fiscal.itens[ ].item.ncmstring10obrigatórioNCM do item
retorno.nota_fiscal.itens[ ].item.quantidade (5)decimal- obrigatórioQuantidade do item
retorno.nota_fiscal.itens[ ].item.valor_unitario (5)decimal- obrigatórioValor unitário do item
retorno.nota_fiscal.itens[ ].item.valor_total (5)decimal- obrigatórioValor total do item
retorno.nota_fiscal.itens[ ].item.cfopstring4obrigatórioCFOP do item
retorno.nota_fiscal.itens[ ].item.naturezastring80obrigatórioNatureza de operação do item
retorno.nota_fiscal.base_icms (5)decimalopcionalValor da base do ICMS da nota fiscal
retorno.nota_fiscal.valor_icms (5)decimalopcionalValor do ICMS da nota fiscal
retorno.nota_fiscal.base_icms_st (5)decimalopcionalValor da base do ICMS ST da nota fiscal
retorno.nota_fiscal.valor_icms_st (5)decimalopcionalValor do ICMS ST da nota fiscal
retorno.nota_fiscal.valor_servicos (5)decimalopcionalValor dos serviços da nota fiscal
retorno.nota_fiscal.valor_produtos (5)decimalopcionalValor dos produtos da nota fiscal
retorno.nota_fiscal.valor_frete (5)decimalopcionalValor do frete da nota fiscal
retorno.nota_fiscal.valor_seguro (5)decimalopcionalValor do seguro da nota fiscal
retorno.nota_fiscal.valor_outras (5)decimalopcionalValor das outras despesas da nota fiscal
retorno.nota_fiscal.valor_ipi (5)decimalopcionalValor do IPI da nota fiscal
retorno.nota_fiscal.valor_issqn (5)decimalopcionalValor do ISSQN da nota fiscal
retorno.nota_fiscal.valor_nota (5)decimalopcionalValor da Nota Fiscal
retorno.nota_fiscal.valor_desconto (5)decimalopcionalValor do desconto da Nota Fiscal
retorno.nota_fiscal.valor_faturado (5)decimalopcionalValor total faturado da Nota Fiscal
retorno.nota_fiscal.frete_por_contastring1opcionalR - Contratação do Frete por conta do Remetente (CIF), D - Contratação do Frete por conta do Destinatário (FOB), T - Contratação do Frete por conta de Terceiros, 3 - Transporte Próprio por conta do Remetente, 4 - Transporte Próprio por conta do Destinatário, S - Sem Ocorrência de Transporte
retorno.nota_fiscal.transportador object10opcionalElemento utilizado para representar o transportador
retorno.nota_fiscal.transportador.nomestring30obrigatórioNome do transportador
retorno.nota_fiscal.transportador.cpf_cnpjstring18opcionalCPF ou CNPJ do transportador
retorno.nota_fiscal.transportador.iestring18opcionalInscrição estadual do transportador
retorno.nota_fiscal.transportador.enderecostring50opcionalEndereço do transportador
retorno.nota_fiscal.transportador.cidadestring30opcionalNome da cidade do transportador conforme a Tabela de Cidades
retorno.nota_fiscal.transportador.ufstring30opcionalUF do transportador
retorno.nota_fiscal.placastring8opcionalPlaca do veículo transportador
retorno.nota_fiscal.uf_placastring8opcionalUF da placa do veículo transportador
retorno.nota_fiscal.quantidade_volumesintopcionalQuantidade de volumes da Nota Fiscal
retorno.nota_fiscal.especie_volumesstring20opcionalEspécie dos volumes da Nota Fiscal
retorno.nota_fiscal.marca_volumesstring20opcionalMarca dos volumes da Nota Fiscal
retorno.nota_fiscal.numero_volumesstring10opcionalNúmero dos volumes da Nota Fiscal
retorno.nota_fiscal.peso_bruto (5)decimalopcionalPeso Bruto da Nota Fiscal
retorno.nota_fiscal.peso_liquido (5)decimalopcionalPeso Líquido da Nota Fiscal
retorno.nota_fiscal.forma_envio.idintopcionalCódigo da forma de envio
retorno.nota_fiscal.forma_envio.descricaostring30opcionalDescrição da forma de envio
retorno.nota_fiscal.forma_frete.idintopcionalCódigo da forma de frete
retorno.nota_fiscal.forma_frete.descricaostring60opcionalDescrição da forma de frete da Nota Fiscal
retorno.nota_fiscal.codigo_rastreamentostring20condicionalCódigo de rastreamento da Nota Fiscal
retorno.nota_fiscal.url_rastreamentostring120condicionalURL de rastreamento da Nota Fiscal
retorno.nota_fiscal.forma_pagamentostring30obrigatórioCódigo conforme tabela de Formas de pagamento
retorno.nota_fiscal.meio_pagamentostring100opcionalDescrição do meio de pagamento
retorno.nota_fiscal.condicao_pagamentostring30opcionalDescrição da condição de pagamento
retorno.nota_fiscal.parcelas[ ]listopcionalLista de parcelas da Nota Fiscal
retorno.nota_fiscal.parcelas[ ].parcelaobjectopcionalElemento utilizado para representar uma parcela da Nota Fiscal
retorno.nota_fiscal.parcelas[ ].parcela.diasint20opcionalDias de Vencimento da Parcela
retorno.nota_fiscal.parcelas[ ].parcela.data (4)date10opcionalData de Vencimento da Parcela
retorno.nota_fiscal.parcelas[ ].parcela.valor (5)decimal- opcionalValor da parcela
retorno.nota_fiscal.parcelas[ ].parcela.obsstring100opcionalObservação da parcela
retorno.nota_fiscal.parcelas[ ].parcela.forma_pagamentostring30obrigatórioCódigo conforme tabela de Formas de pagamento
retorno.nota_fiscal.parcelas[ ].parcela.meio_pagamentostring100opcionalDescrição do meio de pagamento
retorno.nota_fiscal.id_vendaint-condicionalNúmero de identificação da venda associada à nota fiscal.
retorno.nota_fiscal.id_vendedorint-opcionalNúmero de identificação do Vendedor associado a nota fiscal.
retorno.nota_fiscal.nome_vendedorstring50opcionalNome do Vendedor associado a nota fiscal.
retorno.nota_fiscal.situacao int-opcionalCódigo conforme Tabela de situações da nota fiscal
retorno.nota_fiscal.descricao_situacao string30opcionalDescrição conforme Tabela de situações da nota fiscal
retorno.nota_fiscal.obsstring100opcionalObservação da Nota Fiscal
retorno.nota_fiscal.chave_acessostring100opcionalChave de acesso da Nota Fiscal
retorno.nota_fiscal.marcadores[ ]listopcionalLista de marcadores da Nota Fiscal
retorno.nota_fiscal.marcadores[ ].marcadorobjectopcionalElemento utilizado para representar um marcador da Nota Fiscal
retorno.nota_fiscal.marcadores[ ].marcador.idint-opcionalIdentificação do marcador no Tiny
retorno.nota_fiscal.marcadores[ ].marcador.descricaostring50opcionalDescrição do marcador
retorno.nota_fiscal.marcadores[ ].marcador.corstring-opcionalHexadecimal da cor do marcador
retorno.nota_fiscal.intermediadorobjectopcionalIntermediador
retorno.nota_fiscal.intermediador.nomestring60obrigatórioNome no intermediador
retorno.nota_fiscal.intermediador.cnpjstring18obrigatórioCNPJ do intermediador
retorno.nota_fiscal.intermediador.cnpjPagamentostring18opcionalCNPJ da instituição de pagamento do intermediador

(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".


$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=JSON";

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