Incluir Adicional de Contrato API 2.0
Serviço destinado a inclusão 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 |
| adicional (1) | - | obrigatório | Dados do adicional conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| adicional | object | - | obrigatório | Elemento utilizado para representar um adicional |
| adicional.idContrato (1) | int | obrigatório | Número de identificação do contrato no Tiny | |
| adicional.mes | int | 2 | obrigatório | Mês do adicional |
| adicional.ano | int | 4 | obrigatório | Ano do adicional |
| adicional.valor (2) | decimal | - | obrigatório | Valor do adicional |
| adicional.tipo | string | 1 | obrigatório | Tipo do adicional: D (desconto) ou C (cobrança) |
| adicional.historico | string | 150 | opcional | Histórico do adicional |
| adicional.periodo | string | 100 | opcional | Período do adicional |
(1) - Este campo será utilizado para localizar o contrato em que será adicionado o valor adicional.
(2) - Estes campos utilizam "." (ponto) como separador de decimais, exemplo "5.25".
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.registros[ ] (2) | list | - | condicional | Lista de resultados da inclusão |
| retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar um adicional. |
| retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada adicional (1). |
| retorno.registros[ ].registro.status | string | - | condicional | Contém o status do registro "OK" ou "Erro". Para o caso de conter erros estes serão descritos abaixo |
| retorno.registros[ ].registro.codigo_erro | int | - | condicional | Conforme tabela "Códigos de erro" |
| retorno.registros[ ].registro.erros[ ] (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.registros[ ].registro.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.registros[ ].registro.id | int | - | condicional | Número de identificação do adicional no Tiny |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos do parâmetro adicional
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/contrato.adicional.incluir.php';
$token = 'coloque aqui a sua chave da api';
$adicional = '<adicional>...</adicional>';
$data = "token=$token&adicional=$adicional&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;
}
