Consultar Horas Usadas em Contrato de Horas pelo Cliente

Recurso Premium Recurso Enterprise

Este método permite consultar o contrato de horas usadas vs horas contratadas pelo cliente durante o mês corrente.

Endpoint

Método	Rota	Content-Type
`GET`	`https://api.tomticket.com/v2.0/customer/hourcontract`	`application/json`

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.

Campo	Tipo	Obrigatório	Tamanho máximo	Descrição
`customer_id`	string	Sim	250	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.
`customer_type_id`	string	Não	1	Tipo de identificador utilizado para localizar o cliente: I - Identificador interno; E - Email.

Campo	Tipo	Descrição
`error`	boolean	Informa se ocorreu um erro na operação.
`message`	string	Detalhes da operação, caso tenha ocorrido ou não um problema.
`success`	boolean	Retorna true caso a operação tenha sido concluída com sucesso.
`period`	string	Ano e mês correspondente à pesquisa no formato YYYY-MM.
`data`	array	Lista com os contratos encontrados.
`department_id`	string	Identificador do departamento do contrato de horas.
`category_id`	string	Identificador da categoria do contrato de horas.
`hours`	array	Lista com as horas contratadas e horas usadas.
`contracted`	integer	Total de horas contratadas em minutos.
`used`	integer	Total de horas usadas em minutos.

Status HTTP	Mensagem	Quando ocorre
401	Token ou valores enviados não autorizados para uso.	Quando a autenticação ou os valores enviados não são autorizados.
403	Recurso não disponível.	Quando o recurso não está disponível.
404	Recurso não encontrado.	Quando o recurso não é encontrado.