Incluir Nota Fiscal API 2.0
Serviço destinado a fazer inclusão de Notas Fiscais.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
nota (1) | - | obrigatório | Dados da nota conforme layout |
formato | string | obrigatório | Formato do retorno (json ou xml) |
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
nota_fiscal | object | - | obrigatório | Elemento utilizado para representar uma nota fiscal. |
nota_fiscal.tipo | string | 1 | opcional | Tipo de nota fiscal (E - Entrada, S - Saída), caso não seja informado o valor padrão é "S" |
nota_fiscal.natureza_operacao (1) | string | 50 | opcional | Natureza de operação da nota fiscal previamente cadastrada no Tiny |
nota_fiscal.data_emissao (2) | date | 10 | opcional | Data de emissão da nota fiscal |
nota_fiscal.hora_emissao (3) | string | 8 | opcional | Hora de emissão da nota |
nota_fiscal.data_entrada_saida (2) | date | 10 | opcional | Data entrada/saída da nota fiscal |
nota_fiscal.hora_entrada_saida (3) | string | 8 | opcional | Hora entrada/saída da nota fiscal |
nota_fiscal.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
nota_fiscal.cliente.codigo (7) | string | 30 | opcional | Código do cliente |
nota_fiscal.cliente.nome (7) | string | 50 | obrigatório | Nome do cliente |
nota_fiscal.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
nota_fiscal.cliente.cpf_cnpj (7) | string | 18 | opcional | CPF ou CNPJ do cliente |
nota_fiscal.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
nota_fiscal.cliente.rg | string | 10 | opcional | RG do cliente |
nota_fiscal.cliente.endereco | string | 50 | opcional | Endereço do cliente |
nota_fiscal.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
nota_fiscal.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
nota_fiscal.cliente.bairro | string | 30 | opcional | Bairro do cliente |
nota_fiscal.cliente.cep | string | 10 | opcional | Cep do cliente |
nota_fiscal.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
nota_fiscal.cliente.uf | string | 2 | opcional | UF do cliente |
nota_fiscal.cliente.pais | string | 50 | opcional | Nome do País do cliente conforme Tabela de Países |
nota_fiscal.cliente.fone | string | 40 | opcional | Telefone do cliente |
nota_fiscal.cliente.email | string | 50 | opcional | Email do cliente |
nota_fiscal.cliente.atualizar_cliente (10) | string | 1 | opcional | ("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S" |
nota_fiscal.endereco_entrega | object | opcional | Elemento utilizado para representar o endereço de entrega, caso seja diferente do endereço do cliente | |
nota_fiscal.endereco_entrega.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
nota_fiscal.endereco_entrega.cpf_cnpj (7) | string | 18 | opcional | CPF ou CNPJ de entrega |
nota_fiscal.endereco_entrega.endereco | string | 50 | opcional | Endereço de entrega |
nota_fiscal.endereco_entrega.numero | string | 10 | opcional | Número do endereço de entrega |
nota_fiscal.endereco_entrega.complemento | string | 50 | opcional | Complemento do endereço de entrega |
nota_fiscal.endereco_entrega.bairro | string | 30 | opcional | Bairro de entrega |
nota_fiscal.endereco_entrega.cep | string | 10 | opcional | Cep de entrega |
nota_fiscal.endereco_entrega.cidade | string | 30 | opcional | Nome da cidade de entrega conforme a Tabela de Cidades |
nota_fiscal.endereco_entrega.uf | string | 30 | opcional | UF de entrega |
nota_fiscal.endereco_entrega.fone | string | 40 | opcional | Telefone de entrega |
nota_fiscal.endereco_entrega.nome_destinatario | string | 60 | opcional | Nome do destinatário da entrega |
nota_fiscal.endereco_entrega.ie | string | 18 | opcional | Inscrição estadual de entrega |
nota_fiscal.itens[ ] | list | obrigatório | Lista dos itens da nota | |
nota_fiscal.itens[ ].item | object | obrigatório | Elemento utilizado para representar uma nota | |
nota_fiscal.itens[ ].item.codigo (8) | string | 60 | opcional | Código do Produto |
nota_fiscal.itens[ ].item.descricao (8) | string | 120 | obrigatório | Descrição do Produto |
nota_fiscal.itens[ ].item.unidade | string | 2 | obrigatório | Unidade do produto |
nota_fiscal.itens[ ].item.quantidade (4) | decimal | - | obrigatório | Quantidade do produto |
nota_fiscal.itens[ ].item.valor_unitario (4) | decimal | - | obrigatório | Valor unitário do produto |
nota_fiscal.itens[ ].item.tipo | string | 1 | obrigatório | Indica se é produto("P") ou serviço("S") |
nota_fiscal.itens[ ].item.origem | string | 1 | opcional | Código conforme Tabela Origem |
nota_fiscal.itens[ ].item.numero_fci | string | 36 | opcional | Número de controle da FCI - Ficha de Conteúdo de Importação |
nota_fiscal.itens[ ].item.ncm | string | 10 | opcional | NCM do produto |
nota_fiscal.itens[ ].item.peso_bruto (4) | decimal | - | opcional | Peso Bruto do produto |
nota_fiscal.itens[ ].item.peso_liquido (4) | decimal | - | opcional | Peso Líquido do produto |
nota_fiscal.itens[ ].item.gtin_ean | string | 14 | opcional | GTIN/EAN do produto |
nota_fiscal.itens[ ].item.gtin_ean_embalagem | string | 14 | opcional | GTIN/EAN da embalagem do produto |
nota_fiscal.itens[ ].item.codigo_lista_servicos (5) | string | 5 | opcional | Código da lista de serviços |
nota_fiscal.itens[ ].item.aliquota_comissao (2) | decimal | - | opcional | Valor da aliquota de comissão do item |
nota_fiscal.itens[ ].item.cest | string | 10 | opcional | Código cest do item |
nota_fiscal.itens[ ].item.numero_pedido_compra | string | 15 | opcional | Nº do pedido de compra |
nota_fiscal.itens[ ].item.numero_item_pedido_compra | int | - | opcional | Nº do item no pedido de compra |
nota_fiscal.itens[ ].item.descricao_complementar | string | 100 | opcional | Informações adicionais do item |
nota_fiscal.forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
nota_fiscal.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
nota_fiscal.parcelas | list | opcional | Lista de parcelas da nota | |
nota_fiscal.parcelas[ ].parcela | object | opcional | Elemento utilizado para representar uma parcela da nota | |
nota_fiscal.parcelas[ ].parcela.dias | int | 20 | opcional | Dias de Vencimento da Parcela |
nota_fiscal.parcelas[ ].parcela.data (2) | date | 10 | opcional | Data de Vencimento da Parcela |
nota_fiscal.parcelas[ ].parcela.valor (4) | decimal | - | opcional | Valor da parcela |
nota_fiscal.parcelas[ ].parcela.obs | string | 100 | opcional | Observação da parcela |
nota_fiscal.parcelas[ ].parcela.destino | string | 50 | opcional | Destino da parcela (Ex:Caixa, Contas a Receber), por padrão as parcelas vão para contas a receber |
nota_fiscal.parcelas[ ].parcela.forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
nota_fiscal.parcelas[ ].parcela.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
nota_fiscal.transportador | object | opcional | Elemento utilizado para representar o transportador | |
nota_fiscal.transportador.codigo (9) | string | 30 | opcional | Código do transportador |
nota_fiscal.transportador.nome (9) | string | 30 | opcional | Nome do transportador |
nota_fiscal.transportador.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
nota_fiscal.transportador.cpf_cnpj (9) | string | 18 | opcional | CPF ou CNPJ do transportador |
nota_fiscal.transportador.ie | string | 18 | opcional | Inscrição estadual do transportador |
nota_fiscal.transportador.endereco | string | 50 | opcional | Endereço do transportador |
nota_fiscal.transportador.cidade | string | 30 | opcional | Cidade do transportador, conforme Tabela de Cidades |
nota_fiscal.transportador.uf | string | 2 | opcional | UF do transportador |
nota_fiscal.forma_envio | string | 30 | opcional | Forma de envio, conforme Tabela de forma de envio |
nota_fiscal.forma_frete | string | 30 | opcional | Forma de frete de acordo com o cadastro no Tiny |
nota_fiscal.frete_por_conta | string | 1 | obrigatório | "R"-Remetente, "D"-Destinatário |
nota_fiscal.placa_veiculo | string | 1 | opcional | Placa do veículo transportador |
nota_fiscal.uf_veiculo | string | 1 | opcional | UF da placa do veículo transportador |
nota_fiscal.quantidade_volumes | int | - | opcional | Quantidade de volumes da nota fiscal |
nota_fiscal.especie_volumes | string | 20 | opcional | Espécie dos volumes da nota fiscal |
nota_fiscal.marca_volumes | string | 20 | opcional | Marca dos volumes da nota fiscal |
nota_fiscal.numero_volumes | string | 20 | opcional | Número dos volumes da nota fiscal |
nota_fiscal.valor_desconto (4) | decimal | - | opcional | Valor do desconto da nota fiscal |
nota_fiscal.valor_frete (4) | decimal | - | opcional | Valor do frete da nota fiscal |
nota_fiscal.valor_seguro (4) | decimal | - | opcional | Valor do seguro da nota fiscal |
nota_fiscal.valor_despesas (4) | decimal | - | opcional | Valor das outras despesas da nota fiscal |
nota_fiscal.nf_produtor_rural | object | opcional | Elemento utilizado para representar a nota fiscal de referencia do produtor rural | |
nota_fiscal.nf_produtor_rural.serie | string | 3 | opcional | Série da nota fiscal do produtor |
nota_fiscal.nf_produtor_rural.numero | string | 10 | opcional | Número da nota fiscal do produtor |
nota_fiscal.nf_produtor_rural.ano_mes_emissao | string | 4 | opcional | Ano e mês da emissão da nota no formato AAMM |
nota_fiscal.id_vendedor (11) | int | - | opcional | Número de identificação do Vendedor cadastrado no Tiny. |
nota_fiscal.nome_vendedor (11) (12) | string | 50 | opcional | Nome do Vendedor cadastrado no Tiny. |
nota_fiscal.numero_pedido_ecommerce | string | 50 | opcional | Número de identificação do pedido no e-commerce (ou no seu sistema) |
nota_fiscal.finalidade | int | - | opcional | Código de finalidade da nota fiscal confome a Tabela de Finalidade das Notas Fiscais |
nota_fiscal.refNFe (13) | string | 44 | opcional | Chave de acesso da NF-e referenciada |
nota_fiscal.obs | string | 100 | opcional | Observação da nota fiscal |
nota_fiscal.ecommerce | string | 50 | opcional | Plataforma que está enviando a 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) - Caso seja informado um valor diferente da aliquota cadastrada para o vendedor a aliquota do vendedor será desconsiderada. Caso seja informado o valor zero a aliquota deste item será zero.
(7) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja os demais campos são carregados do cadastro.
(8) - Estes campos são utilizados para pesquisar se o produto está cadastrado, caso esteja os demais campos são carregados do cadastro.
(9) - Estes campos são utilizados para pesquisar se o transportador está cadastrado, caso esteja os demais campos são carregados do cadastro.
(10) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(11) - Caso o vendedor não seja localizado será apresentado um erro de validação.
(12) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
(13) - Este campo será considerado apenas para as finalidades com valor 3, 4 ou 9.
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 | - | obrigatório | 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.registros[ ] (2) | list | - | condicional | Lista de resultados da inclusão |
retorno.registros[ ].registro (2) | - | object | condicional | Elemento utilizado para representar uma nota fiscal. |
retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada pedido. |
retorno.registros[ ].registro.status | string | - | condicional | Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.registros[ ].registro.codigo_erro | int | - | condicional | Conforme 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[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.registros[ ].registro.id | int | - | condicional | Número de identificação do nota fiscal no Tiny |
retorno.registros[ ].registro.serie | string | 3 | condicional | Série da nota fiscal no Tiny |
retorno.registros[ ].registro.numero | int | - | condicional | Nú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.
Exemplos do parâmetro nota
<?xml version="1.0" encoding="UTF-8"?>
<nota_fiscal>
<tipo>S</tipo>
<natureza_operacao>Venda de Mercadorias</natureza_operacao>
<data_emissao>20/10/2012</data_emissao>
<data_entrada_saida>22/10/2012</data_entrada_saida>
<hora_entrada_saida>15:30</hora_entrada_saida>
<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>
<email>teste@teste.com.br</email>
<atualizar_cliente>N</atualizar_cliente>
</cliente>
<itens>
<item>
<codigo>1234</codigo>
<descricao>Produto Teste 1</descricao>
<unidade>UN</unidade>
<quantidade>2</quantidade>
<valor_unitario>50.25</valor_unitario>
<tipo>P</tipo>
<origem>0</origem>
<numero_fci>B01F70AF-10BF-4B1F-848C-65FF57F616FE</numero_fci>
<ncm>1234567890</ncm>
<peso_bruto>1.25</peso_bruto>
<peso_liquido>1.15</peso_liquido>
<gtin_ean>1234567890</gtin_ean>
<gtin_ean_embalagem/>
<codigo_lista_servicos/>
<numero_pedido_compra>1001</numero_pedido_compra>
<numero_item_pedido_compra>10010011</numero_item_pedido_compra>
<descricao_complementar>Informação complementar</descricao_complementar>
</item>
</itens>
<itens>
<item>
<codigo>1235</codigo>
<descricao>Produto Teste 2</descricao>
<unidade>UN</unidade>
<quantidade>4</quantidade>
<valor_unitario>15.25</valor_unitario>
<tipo>P</tipo>
<numero_pedido_compra>1001</numero_pedido_compra>
<numero_item_pedido_compra>10010011</numero_item_pedido_compra>
<descricao_complementar>Informação complementar</descricao_complementar>
</item>
</itens>
<forma_pagamento>multiplas</forma_pagamento>
<parcelas>
<parcela>
<dias>30</dias>
<data>29/11/2012</data>
<valor>53.84</valor>
<obs>Obs Parcela 1</obs>
<forma_pagamento>dinheiro</forma_pagamento>
</parcela>
</parcelas>
<parcelas>
<parcela>
<dias>60</dias>
<data>29/12/2012</data>
<valor>53.83</valor>
<obs>Obs Parcela 2</obs>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco</meio_pagamento>
</parcela>
</parcelas>
<parcelas>
<parcela>
<dias>90</dias>
<data>27/01/2013</data>
<valor>53.83</valor>
<obs>Obs Parcela 3</obs>
<forma_pagamento>credito</forma_pagamento>
<meio_pagamento>Gateway 123</meio_pagamento>
</parcela>
</parcelas>
<transportador>
<codigo>2222</codigo>
<nome>Transportador teste</nome>
<tipo_pessoa>J</tipo_pessoa>
<cpf_cnpj>00000000000000</cpf_cnpj>
<ie>123345</ie>
<endereco>rua teste</endereco>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
</transportador>
<frete_por_conta>R</frete_por_conta>
<placa_veiculo>AAA-0000</placa_veiculo>
<uf_veiculo>RS</uf_veiculo>
<quantidade_volumes>10</quantidade_volumes>
<especie_volumes>Caixas</especie_volumes>
<marca_volumes/>
<numero_volumes/>
<valor_desconto>45.45</valor_desconto>
<valor_frete>35.45</valor_frete>
<valor_seguro>4.00</valor_seguro>
<valor_despesas>1.00</valor_despesas>
<nf_produtor_rural>
<serie/>
<numero/>
<ano_mes_emissao/>
</nf_produtor_rural>
<id_vendedor>123</id_vendedor>
<numero_pedido_ecommerce>123</numero_pedido_ecommerce>
<obs>Observações da nota</obs>
<finalidade>3</finalidade>
<refNFe>186181615165513132135135131213</refNFe>
</nota_fiscal>
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.fiscal.incluir.php';
$token = 'coloque aqui a sua chave da api';
$nota = '<nota_fiscal>...</nota_fiscal>';
$data = "token=$token¬a=$nota&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 SoapClient("https://api.tiny.com.br/api2.php?wsdl");
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;
$result = $client->call("incluirNotaFiscalService", array('token' => 'xxxxx','nota'=>'<nota_fiscal>...</nota_fiscal>','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>
<registros>
<registro>
<sequencia>1</sequencia>
<status>Erro</status>
<codigo_erro>30</codigo_erro>
<erros>
<erro>Registro em duplicidade</erro>
</erros>
</registro>
</registros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<registros>
<registro>
<sequencia>1</sequencia>
<status>OK</status>
<id>37644545</id>
<serie>1</serie>
<numero>00001</numero>
</registro>
</registros>
</retorno>