Pesquisar Adicionais de Contrato API 2.0
Serviço destinado a pesquisa de adicionais de contratos.
Parâmetros do serviço
| 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) |
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.adicionais[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
| retorno.adicionais[ ].adicional (2) | 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 de chamada da API
$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;
}
