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

Pesquisar Contratos API 2.0

Serviço destinado a fazer consulta de Contratos.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
cliente (1)stringopcionalNome ou código (ou parte) do cliente
cpf_cnpj (1)stringopcionalCPF ou CNPJ do cliente
dataInicial (1)stringopcionalData incial dos contratos que deseja consultar no formato dd/mm/yyyy
dataFinal (1)stringopcionalData final dos contratos que deseja consultar no formato dd/mm/yyyy
situacao (1) (2)stringopcionalExibir contratos na situação
idVendedor (3)intopcionalNúmero de identificação do vendedor no Tiny
nomeVendedor (3) (4)stringopcionalNome do vendedor no Tiny
pagina (5)intopcionalNúmero da página

(1) - Ao menos um desses parâmetros deve ser informado.
(2) - Código da situação, conforme tabela de Situações dos Contratos.
(3) - Caso o vendedor não seja localizado no Tiny a consulta não retornará registros.
(4) - Este valor será desconsiderado caso seja informado valor para o parâmetro idVendedor.
(5) - Numero da página que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.

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) (3)list-condicional [0..n]Contém a lista dos erros encontrados
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.contratos[ ] (2)list-condicionalLista de resultados da pesquisa
retorno.contratos[ ].contrato (2)object-condicionalElemento utilizado para representar um contrato
retorno.contratos[ ].idint-obrigatórioNúmero de identificação do contrato no Tiny
retorno.contratos[ ].data (4)date10obrigatórioData do contrato
retorno.contratos[ ].descricaostring50obrigatórioDescrição do contrato
retorno.contratos[ ].nomestring50obrigatórioNome do cliente
retorno.contratos[ ].valor (5)decimal-obrigatórioValor total do contrato
retorno.contratos[ ].id_vendedorint15condicionalNúmero de identificação do vendedor associado ao contrato
retorno.contratos[ ].nome_vendedorstring50condicionalNome do vendedor associado ao contrato
retorno.contratos[ ].situacaoint-obrigatórioCódigo conforme tabela de Situações dos Contratos
retorno.contratos[ ].descricao_situacaostring25obrigatórioDescriçã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 somente serão informados caso o retorno contenha erros.
(4) - Estes campos utilizam o formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".


$url = 'https://api.tiny.com.br/api2/contratos.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$numero = 'xxxxx';
$data = "token=$token&numero=$numero&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;
}