Incluir Nota de Serviço API 2.0
Serviço destinado a fazer inclusão de Notas Fiscais de Serviço.
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_servico | object | - | obrigatório | Elemento utilizado para representar uma nota de serviço |
nota_servico.data_emissao (1) | date | 10 | opcional | Data de emissão da nota de serviço |
nota_servico.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
nota_servico.cliente.codigo (3) | string | 30 | opcional | Código do cliente |
nota_servico.cliente.nome (3) | string | 50 | obrigatório | Nome do cliente |
nota_servico.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
nota_servico.cliente.cpf_cnpj (3) | string | 18 | opcional | CPF ou CNPJ do cliente |
nota_servico.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
nota_servico.cliente.rg | string | 10 | opcional | RG do cliente |
nota_servico.cliente.endereco | string | 50 | opcional | Endereço do cliente |
nota_servico.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
nota_servico.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
nota_servico.cliente.bairro | string | 30 | opcional | Bairro do cliente |
nota_servico.cliente.cep | string | 10 | opcional | Cep do cliente |
nota_servico.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
nota_servico.cliente.uf | string | 2 | opcional | UF do cliente |
nota_servico.cliente.pais | string | 50 | opcional | Nome do país do cliente conforme Tabela de Países |
nota_servico.cliente.fone | string | 40 | opcional | Telefone do cliente |
nota_servico.cliente.email | string | 50 | opcional | Email do cliente |
nota_servico.cliente.atualizar_cliente (4) | 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_servico.servico | object | obrigatório | Elemento utilizado para representar o serviço | |
nota_servico.servico.descricao | string | 300 | obrigatório | Descrição do serviço |
nota_servico.servico.valor_servico (2) | decimal | - | obrigatório | Valor do serviço |
nota_servico.servico.codigo_lista_servico | string | 10 | opcional | Código de acordo com a lista de serviços |
nota_servico.servico.codigo_nbs | string | 12 | opcional | Código NBS |
nota_servico.tributacao | int | - | opcional | Opções de tributação conforme tabela de Tributações das Notas de Serviço |
nota_servico.percentual_ir (2) | decimal | - | opcional | Percentual de IR |
nota_servico.texto_ir | string | 150 | opcional | Texto do IR |
nota_servico.percentual_iss (2) | decimal | - | opcional | Percentual do ISS |
nota_servico.descontar_iss_total | string | 1 | obrigatório | ISS Retido(S/N) |
nota_servico.forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
nota_servico.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
nota_servico.parcelas[ ] | list | opcional | Lista de parcelas da nota | |
nota_servico.parcelas[ ].parcela | object | opcional | Elemento utilizado para representar uma parcela | |
nota_servico.parcelas[ ].parcela.dias | int | 20 | opcional | Dias de vencimento da parcela |
nota_servico.parcelas[ ].parcela.data (1) | date | 10 | opcional | Data de vencimento da parcela |
nota_servico.parcelas[ ].parcela.valor (2) | decimal | - | opcional | Valor da parcela |
nota_servico.parcelas[ ].parcela.obs | string | 100 | opcional | Observação da parcela |
nota_servico.parcelas[ ].parcela.forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
nota_servico.parcelas[ ].parcela.meio_pagamento | string | 100 | opcional | Descrição do meio de pagamento |
nota_servico.id_vendedor (5) | int | - | opcional | Número de identificação do Vendedor cadastrado no Tiny. |
nota_servico.nome_vendedor (5) (6) | string | 50 | opcional | Nome do Vendedor cadastrado no Tiny |
nota_servico.percentual_comissao (2) | decimal | - | opcional | Percentual de comissão do vendedor |
nota_servico.condicoes | string | 30 | opcional | Texto contendo as condições da nota |
nota_servico.crt (7) | int | 1 | opcional | Código de regime tributário:
|
(1) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(2) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(3) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja, os demais campos são carregados do cadastro.
(4) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(5) - Estes campos são utilizados para pesquisar se o vendedor está cadastrado, caso o vendedor não seja localizado será apresentado um erro de validação.
(6) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
(7) - Este campo será desconsiderado se o campo "tipo_pessoa" for igual a "F".
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 de serviço |
retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada nota |
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 de serviço no Tiny |
retorno.registros[ ].registro.serie | string | 3 | condicional | Série da nota de serviço no Tiny |
retorno.registros[ ].registro.numero | int | - | condicional | Número da nota de serviço no Tiny |
retorno.registros[ ].registro.numeroRPS | int | - | condicional | Número da RPS 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_servico>
<data_emissao>14/02/2013</data_emissao>
<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>95700-000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>(54) 3055 3808</fone>
<email>teste@teste.com.br</email>
<atualizar_cliente>N</atualizar_cliente>
</cliente>
<servico>
<descricao>Serviço teste</descricao>
<valor_servico>150.96</valor_servico>
<codigo_lista_servico>1.02</codigo_lista_servico>
</servico>
<percentual_ir>1.5</percentual_ir>
<texto_ir>IR Isento Cfe. Lei nro. 9430/96 Art.64</texto_ir>
<percentual_iss>2</percentual_iss>
<descontar_iss_total>N</descontar_iss_total>
<forma_pagamento>boleto</forma_pagamento>
<meio_pagamento>Bradesco X</meio_pagamento>
<parcelas>
<parcela>
<dias>30</dias>
<data>16/03/2013</data>
<valor>50.32</valor>
<obs>Obs Parcela 1</obs>
</parcela>
<parcela>
<dias>60</dias>
<data>16/04/2013</data>
<valor>50.32</valor>
<obs>Obs Parcela 2</obs>
</parcela>
<parcela>
<dias>90</dias>
<data>16/05/2013</data>
<valor>50.32</valor>
<obs>Obs Parcela 3</obs>
</parcela>
</parcelas>
<percentual_comissao>5.00</percentual_comissao>
<condicoes>teste</condicoes>
</nota_servico>
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.servico.incluir.php';
$token = 'coloque aqui a sua chave da api';
$nota = '<nota_servico>...</nota_servico>';
$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("incluirNotaServicoService", array('token' => 'xxxxx','nota'=>'<nota_servico>...</nota_servico>','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>
<numeroRPS>00001</numeroRPS>
</registro>
</registros>
</retorno>