Incluir Nota Fiscal ConsumidorAPI 2.0
Serviço destinado a fazer inclusão de Notas Fiscais de Consumidor.
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) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| nota_fiscal | object | - | obrigatório | Elemento utilizado para representar uma nota fiscal. |
| nota_fiscal.natureza_operacao (1) | string | 50 | opcional | Natureza de operação da nota fiscal previamente cadastrada no Tiny |
| nota_fiscal.cliente | object | opcional | Elemento 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) | string | 30 | opcional | Código do cliente |
| nota_fiscal.cliente.nome (6) | string | 50 | opcional | 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 (6) | 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 (9) | 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.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 (7) | string | 60 | opcional | Código do Produto |
| nota_fiscal.itens[ ].item.descricao (7) | 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 (4) | 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 (8) | string | 30 | opcional | Código do transportador |
| nota_fiscal.transportador.nome (8) | 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 (8) | 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.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_despesas (4) | decimal | - | opcional | Valor das outras despesas da nota fiscal |
| nota_fiscal.id_vendedor (10) | int | - | opcional | Número de identificação do Vendedor cadastrado no Tiny. |
| nota_fiscal.nome_vendedor (10) (11) | string | 50 | opcional | Nome do Vendedor cadastrado no Tiny. |
| nota_fiscal.obs | string | 100 | opcional | Observaçã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.
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 da 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
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.fiscal.consumidor.incluir.php';
$token = 'coloque aqui a sua chave da api';
$nota = '{...}';
$data = "token=$token¬a=$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;
}
