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

Pesquisar Adicionais de Contrato API 2.0

Serviço destinado a pesquisa de adicionais de contratos.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idContratointobrigatórioId do contrato que será pesquisado
formatostringobrigatórioFormato do retorno (json)
ElementoTipoTamanhoOcorrênciaDescrição
retorno-objectobrigató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-obrigatórioConforme 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.adicionais[ ] (2)list-condicionalLista de resultados da pesquisa
retorno.adicionais[ ].adicional (2)object-condicionalElemento utilizado para representar um adicional
retorno.adicionais[ ].adicional.idint-obrigatórioNúmero de identificação do adicional no Tiny
retorno.adicionais[ ].adicional.idContratoint-obrigatórioNúmero de identificação do contrato associado
retorno.adicionais[ ].adicional.mesint2obrigatórioMês do adicional
retorno.adicionais[ ].adicional.anoint4obrigatórioAno do adicional
retorno.adicionais[ ].adicional.valordecimal-obrigatórioValor do adicional
retorno.adicionais[ ].adicional.tipostring1obrigatórioTipo do adicional: D (desconto) ou C (cobrança)
retorno.adicionais[ ].adicional.historicostring150obrigatórioHistórico do adicional
retorno.adicionais[ ].adicional.periodostring100obrigatórioPeríodo do adicional

(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.


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