Este método permite consultar o contrato de horas usadas vs horas contratadas pelo cliente durante o mês corrente.
Endpoint
https://api.tomticket.com/v2.0/customer/hourcontract
Método HTTP
GET
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Parâmetros Query String
Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
customer_id | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado. | Sim | - | String | 250 |
customer_type_id | Tipo de identificador utilizado para localizar o cliente, sendo:I - Identificador internoE - Email | Não | I | String | 1 |
Retorno
Descrição do retorno em JSON.
| Coluna | Descrição da Coluna | Tipo |
|---|---|---|
error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
period | Ano e mês correspondente à pesquisa no formato YYYY-MM. | String |
data | Lista com os contratos encontrados. | Array |
| Identificador do departamento do contrato de horas. | String |
| Identificador da categoria do contrato de horas. | String |
| Lista com as horas contratadas e horas usadas | Array |
| Total de horas contratadas em minutos. | Int |
| Total de horas usadas em minutos. | Int |
Código de Retorno
Descrição do código HTTP de retorno.
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. |
| 403 | Recurso não disponível. |
| 404 | Recurso não encontrado. |
Disponibilidade
