Pesquisar Adicionais de Contrato API 2.0

Serviço destinado a pesquisa de adicionais de contratos.

REST
SOAP

REST URL

SOAP WSDL

WSDL Service

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
idContrato	int	obrigatório	Id do contrato que será pesquisado
formato	string	obrigatório	Formato do retorno (json ou xml)

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 ⁽¹⁾	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.adicionais[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.adicionais[ ].adicional ⁽²⁾	object	-	condicional	Elemento utilizado para representar um adicional
retorno.adicionais[ ].adicional.id	int	-	obrigatório	Número de identificação do adicional no Tiny
retorno.adicionais[ ].adicional.idContrato	int	-	obrigatório	Número de identificação do contrato associado
retorno.adicionais[ ].adicional.mes	int	2	obrigatório	Mês do adicional
retorno.adicionais[ ].adicional.ano	int	4	obrigatório	Ano do adicional
retorno.adicionais[ ].adicional.valor	decimal	-	obrigatório	Valor do adicional
retorno.adicionais[ ].adicional.tipo	string	1	obrigatório	Tipo do adicional: D (desconto) ou C (cobrança)
retorno.adicionais[ ].adicional.historico	string	150	obrigatório	Histórico do adicional
retorno.adicionais[ ].adicional.periodo	string	100	obrigatório	Perí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.

Exemplos da chamada em REST


$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=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;
}

Exemplos da chamada em SOAP


$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("pesquisarContratoAdicionalService", array('token' => 'xxxxx','idContrato'=>'12345','formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML

<?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>20</codigo_erro>
  <erros>
    <erro>A consulta não retornou registros</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <adicionais>
    <adicional>
      <id>998745886</id>
      <idContrato>45588</idContrato>
      <mes>9</mes>
      <ano>2014</ano>
      <valor>20.00</valor>
      <tipo>C</tipo>
      <historico>teste</historico>
      <periodo>teste</periodo>
    </adicional>
    <adicional>
      <id>51568997</id>
      <idContrato>45588</idContrato>
      <mes>1</mes>
      <ano>2015</ano>
      <valor>10.00</valor>
      <tipo>C</tipo>
      <historico>tetes</historico>
      <periodo/>
    </adicional>
  </adicionais>
</retorno>

Pesquisar Adicionais de Contrato API 2.0

Parâmetros do serviço

Retorno do serviço

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos da chamada em SOAP

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML