Fechar
esqueci a minha senha
criar uma conta

Obter Contrato API 2.0

Serviço destinado a obter um Contrato.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do contrato no Tiny
formatostringobrigatórioFormato do retorno (json ou xml)
ElementoTipoTamanhoOcorrênciaDescrição
retornoobject-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) (5)list-condicional [0..n]Contém a lista dos erros encontrados
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.contrato (2)object-condicionalElemento utilizado para representar um contrato
retorno.contrato.idint-obrigatórioNúmero de identificação do contrato no Tiny
retorno.contrato.descricaostring50obrigatórioDescrição do contrato
retorno.contrato.data (3)date10obrigatórioData do contrato
retorno.contrato.cliente object10opcionalElemento utilizado para representar o cliente
retorno.contrato.cliente.nomestring30obrigatórioNome do cliente
retorno.contrato.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.contrato.cliente.cpf_cnpjstring18opcionalCPF ou CNPJ do cliente
retorno.contrato.cliente.iestring18opcionalInscrição estadual do cliente
retorno.contrato.cliente.enderecostring50opcionalEndereço do cliente
retorno.contrato.cliente.numerostring10opcionalNúmero do endereço do cliente
retorno.contrato.cliente.complementostring50opcionalComplemento do endereço do cliente
retorno.contrato.cliente.bairrostring30opcionalBairro do cliente
retorno.contrato.cliente.cepstring10opcionalCep do cliente
retorno.contrato.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
retorno.contrato.cliente.ufstring30opcionalUF do cliente
retorno.contrato.cliente.fonestring40opcionalTelefone do cliente
retorno.contrato.cliente.emailstring40opcionalE-mail do cliente
retorno.contrato.dia_vencimentoint-obrigatórioDia de vencimento do contrato
retorno.contrato.valor (4)decimal-obrigatórioValor do contrato
retorno.contrato.vencimentostring1obrigatórioMês de vencimento do contrato conforme a tabela de Vencimentos dos Contratos
retorno.contrato.periodicidadeint-obrigatórioPeridiocidade de cobrança do contrato conforme a tabela de Peridiocidades dos Contratos
retorno.contrato.id_vendedorint-condicionalNúmero de identificação do Vendedor associado ao contrato.
retorno.contrato.nome_vendedor string50opcionalNome do vendedor associado ao contrato
retorno.contrato.nro_parcelas (4)decimal-opcionalNúmero de parcelas(mensalidades) que vendedorer receberá comissão
retorno.contrato.percentual_comissao (4)decimal-opcionalPercentual de comissão do vendedor
retorno.contrato.emite_notastring1obrigatórioIndica de o contrato emite nota (S/N)
retorno.contrato.nota object10opcionalElemento utilizado para inforar os dados para geração da nota fiscal
retorno.contrato.nota.percentual_iss (4)decimal-opcionalPercentual de iss
retorno.contrato.nota.retorno.contrato.nota.descontar_issstring1opcionalDescontar o valor do iss do total da nota (S/N)
retorno.contrato.nota.codigo_lista_servico string8opcionalCódigo de acordo com a lista de serviços
retorno.contrato.nota.cfop string5opcionalCódigo fiscal de operação
retorno.contrato.nota.natureza_operacao string50opcionalDescrição da natureza de operação da nota
retorno.contrato.nota.texto_nota string300opcionalTexto para a descrição ou observaçõa da nota
retorno.contrato.nota.periodo_referencia string1opcionalPeríodo de referência da cobrança que será incluído nas observações das notas fiscais. Valores aceitos N (Não imprime), C (Mês atual), A (Mês anterior)
retorno.contrato.nota.nome_produto_servico string50opcionalNome do produto ou serviço ao qual o contrato está vinculado
retorno.contrato.nota.codigo_produto_servico string10opcionalCódigo do produto ou serviço ao qual o contrato está vinculado
retorno.contrato.mes_terminoint-opcionalMês de término do contrato
retorno.contrato.ano_terminoint-opcionalAno de término do contrato
retorno.contrato.obsstring300opcionalObservações do contrato
retorno.contrato.situacao int-opcionalCódigo conforme tabela de Situações dos Contratos
retorno.contrato.descricao_situacao string30opcionalDescrição conforme tabela de Situações dos Contratos

(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 devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(4) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(5) - Estes campos somente serão informados caso o retorno contenha erros.


$url = 'https://api.tiny.com.br/api2/contrato.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$data = "token=$token&id=$id&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 nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("obterContratoService", array('token' => 'xxxxx','id'=>'xxxxx','formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}
<?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>
  <codigo_erro>21</codigo_erro>
  <erros>
    <erro>A consulta retornou mais registros que o permitido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <contrato>
    <id>12356</id>
    <data>14/02/2013</data>
    <descricao>Contrato Teste</descricao>
    <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>
    </cliente>
    <dia_vencimento>5</dia_vencimento>
    <valor>100.00</valor>
    <vencimento>C</vencimento>
    <periodicidade>1</periodicidade>
    <id_vendedor>123</id_vendedor>
    <nome_vendedor>Vendedor Teste</nome_vendedor>
    <nro_parcelas>5</nro_parcelas>
    <percentual_comissao>5.00</percentual_comissao>
    <emite_nota>N</emite_nota>
    <nota>
      <percentual_iss>3</percentual_iss>
      <descontar_iss>N</descontar_iss>
      <codigo_lista_servico>1.02.01</codigo_lista_servico>
      <cfop/>
      <natureza_operacao/>
      <periodo_referencia>N</periodo_referencia>
      <nome_produto_servico/>
      <codigo_produto_servico/>
    </nota>
    <mes_termino>12</mes_termino>
    <ano_termino>2015</ano_termino>
    <situacao>A</situacao>
    <situacao>Ativo</situacao>
    <obs>Teste de observações</obs>
  </contrato>
</retorno>