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

Incluir Nota Fiscal ConsumidorAPI 2.0

Serviço destinado a fazer inclusão de Notas Fiscais de Consumidor.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
nota (1)-obrigatórioDados da nota conforme layout
formatostringobrigatórioFormato do retorno (json)
ElementoTipoTamanhoOcorrênciaDescrição
nota_fiscalobject-obrigatórioElemento utilizado para representar uma nota fiscal.
nota_fiscal.natureza_operacao (1)string50opcionalNatureza de operação da nota fiscal previamente cadastrada no Tiny
nota_fiscal.clienteobjectopcionalElemento utilizado para representar o cliente, se um objeto cliente não for informado, o mesmo será marcado como consumidor final.
nota_fiscal.cliente.codigo (6)string30opcionalCódigo do cliente
nota_fiscal.cliente.nome (6)string50opcionalNome do cliente
nota_fiscal.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
nota_fiscal.cliente.cpf_cnpj (6)string18opcionalCPF ou CNPJ do cliente
nota_fiscal.cliente.iestring18opcionalInscrição estadual do cliente
nota_fiscal.cliente.rgstring10opcionalRG do cliente
nota_fiscal.cliente.enderecostring50opcionalEndereço do cliente
nota_fiscal.cliente.numerostring10opcionalNúmero do endereço do cliente
nota_fiscal.cliente.complementostring50opcionalComplemento do endereço do cliente
nota_fiscal.cliente.bairrostring30opcionalBairro do cliente
nota_fiscal.cliente.cepstring10opcionalCep do cliente
nota_fiscal.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
nota_fiscal.cliente.ufstring2opcionalUF do cliente
nota_fiscal.cliente.paisstring50opcionalNome do País do cliente conforme Tabela de Países
nota_fiscal.cliente.fonestring40opcionalTelefone do cliente
nota_fiscal.cliente.emailstring50opcionalEmail do cliente
nota_fiscal.cliente.atualizar_cliente (9)string1opcional("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S"
nota_fiscal.itens[ ]listobrigatórioLista dos itens da nota
nota_fiscal.itens[ ].itemobjectobrigatórioElemento utilizado para representar uma nota
nota_fiscal.itens[ ].item.codigo (7)string60opcionalCódigo do Produto
nota_fiscal.itens[ ].item.descricao (7)string120obrigatórioDescrição do Produto
nota_fiscal.itens[ ].item.unidadestring2obrigatórioUnidade do produto
nota_fiscal.itens[ ].item.quantidade (4)decimal- obrigatórioQuantidade do produto
nota_fiscal.itens[ ].item.valor_unitario (4)decimal- obrigatórioValor unitário do produto
nota_fiscal.itens[ ].item.tipo string1 obrigatórioIndica se é produto("P") ou serviço("S")
nota_fiscal.itens[ ].item.origemstring1opcionalCódigo conforme Tabela Origem
nota_fiscal.itens[ ].item.numero_fcistring36opcionalNúmero de controle da FCI - Ficha de Conteúdo de Importação
nota_fiscal.itens[ ].item.ncmstring10opcionalNCM do produto
nota_fiscal.itens[ ].item.peso_bruto (4)decimal- opcionalPeso Bruto do produto
nota_fiscal.itens[ ].item.peso_liquido (4)decimal- opcionalPeso Líquido do produto
nota_fiscal.itens[ ].item.gtin_eanstring14opcionalGTIN/EAN do produto
nota_fiscal.itens[ ].item.gtin_ean_embalagemstring14opcionalGTIN/EAN da embalagem do produto
nota_fiscal.itens[ ].item.codigo_lista_servicos (5)string5opcionalCódigo da lista de serviços
nota_fiscal.itens[ ].item.aliquota_comissao (4)decimal- opcionalValor da aliquota de comissão do item
nota_fiscal.itens[ ].item.ceststring10opcionalCódigo cest do item
nota_fiscal.itens[ ].item.numero_pedido_comprastring15opcional Nº do pedido de compra
nota_fiscal.itens[ ].item.numero_item_pedido_compraint-opcionalNº do item no pedido de compra
nota_fiscal.itens[ ].item.descricao_complementarstring100opcionalInformações adicionais do item
nota_fiscal.forma_pagamentostring30opcionalCódigo da forma de pagamento conforme Tabela de Formas de Pagamento
nota_fiscal.meio_pagamentostring100opcionalDescrição do meio de pagamento
nota_fiscal.parcelaslistopcionalLista de parcelas da nota
nota_fiscal.parcelas[ ].parcelaobjectopcionalElemento utilizado para representar uma parcela da nota
nota_fiscal.parcelas[ ].parcela.diasint20opcionalDias de Vencimento da Parcela
nota_fiscal.parcelas[ ].parcela.data (2)date10opcionalData de Vencimento da Parcela
nota_fiscal.parcelas[ ].parcela.valor (4)decimal- opcionalValor da parcela
nota_fiscal.parcelas[ ].parcela.obsstring100opcionalObservação da parcela
nota_fiscal.parcelas[ ].parcela.destinostring50opcionalDestino da parcela (Ex:Caixa, Contas a Receber), por padrão as parcelas vão para contas a receber
nota_fiscal.parcelas[ ].parcela.forma_pagamentostring30opcionalCódigo da forma de pagamento conforme Tabela de Formas de Pagamento
nota_fiscal.parcelas[ ].parcela.meio_pagamentostring100opcionalDescrição do meio de pagamento
nota_fiscal.transportadorobjectopcionalElemento utilizado para representar o transportador
nota_fiscal.transportador.codigo (8)string30opcionalCódigo do transportador
nota_fiscal.transportador.nome (8)string30opcionalNome do transportador
nota_fiscal.transportador.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
nota_fiscal.transportador.cpf_cnpj (8)string18opcionalCPF ou CNPJ do transportador
nota_fiscal.transportador.iestring18opcionalInscrição estadual do transportador
nota_fiscal.transportador.enderecostring50opcionalEndereço do transportador
nota_fiscal.transportador.cidadestring30opcionalCidade do transportador, conforme Tabela de Cidades
nota_fiscal.transportador.ufstring2opcionalUF do transportador
nota_fiscal.frete_por_contastring1obrigatório"R"-Remetente, "D"-Destinatário
nota_fiscal.placa_veiculostring1opcionalPlaca do veículo transportador
nota_fiscal.uf_veiculostring1opcionalUF da placa do veículo transportador
nota_fiscal.quantidade_volumesint-opcionalQuantidade de volumes da nota fiscal
nota_fiscal.especie_volumesstring20opcionalEspécie dos volumes da nota fiscal
nota_fiscal.marca_volumesstring20opcionalMarca dos volumes da nota fiscal
nota_fiscal.numero_volumesstring20opcionalNúmero dos volumes da nota fiscal
nota_fiscal.valor_desconto (4)decimal- opcionalValor do desconto da nota fiscal
nota_fiscal.valor_frete (4)decimal- opcionalValor do frete da nota fiscal
nota_fiscal.valor_despesas (4)decimal- opcionalValor das outras despesas da nota fiscal
nota_fiscal.id_vendedor (10)int-opcionalNúmero de identificação do Vendedor cadastrado no Tiny.
nota_fiscal.nome_vendedor (10) (11)string50opcionalNome do Vendedor cadastrado no Tiny.
nota_fiscal.obsstring100opcionalObservação da nota fiscal

(1) - Caso não seja informado valor, o sistema assumirá automaticamente a natureza de operação padrão, de acordo com o tipo de nota(E/S).
(2) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(3) - Estes campos utilizam o formato hh:mm:ss, exemplo "10:45:01".
(4) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(5) - Estes campo é utilizado somente quando o item se trata de um serviço (campo tipo do item for "S").
(6) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja os demais campos são carregados do cadastro.
(7) - Estes campos são utilizados para pesquisar se o produto está cadastrado, caso esteja os demais campos são carregados do cadastro.
(8) - Estes campos são utilizados para pesquisar se o transportador está cadastrado, caso esteja os demais campos são carregados do cadastro.
(9) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(10) - Caso o vendedor não seja localizado será apresentado um erro de validação.
(11) - Este campo será desconsiderado caso haja valor no campo id_vendedor.

ElementoTipoTamanhoOcorrênciaDescrição
retornoobjectobrigató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-obrigatórioConforme 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.registros[ ] (2)list-condicionalLista de resultados da inclusão
retorno.registros[ ].registro (2)-objectcondicionalElemento utilizado para representar uma nota fiscal.
retorno.registros[ ].registro.sequenciaint-condicionalNúmero sequencial utilizado para identificar cada pedido.
retorno.registros[ ].registro.statusstring-condicionalContém o status do registro “OK” ou “Erro”. Para o caso de conter erros, estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erroint-condicionalConforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ](3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.registros[ ].registro.idint-condicionalNúmero de identificação da nota fiscal no Tiny
retorno.registros[ ].registro.seriestring3condicionalSérie da nota fiscal no Tiny
retorno.registros[ ].registro.numeroint-condicionalNúmero da nota fiscal no Tiny

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.


$url = 'https://api.tiny.com.br/api2/nota.fiscal.consumidor.incluir.php';
$token = 'coloque aqui a sua chave da api';
$nota = '{...}';
$data = "token=$token&nota=$nota&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;
}