Timeneye (versão prévia)
Essa interface permite que os usuários integrem os recursos de gerenciamento e acompanhamento de tempo do Timeneye a vários aplicativos e serviços no ecossistema da Microsoft. Aproveitando essa interface, os usuários podem automatizar fluxos de trabalho, sincronizar dados de acompanhamento de tempo e aumentar a produtividade por meio da integração perfeita com outras ferramentas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Support |
| URL | https://support.timeneye.com/ |
| info@timeneye.com |
| Metadados do conector | |
|---|---|
| Publicador | DM Digital Software SRL |
Conector de API timeneye
O Timeneye é uma ferramenta de acompanhamento de tempo projetada para ajudá-lo a gerenciar seus projetos com eficiência. Esse conector permite que você interaja com o Timeneye por meio da API, permitindo que você integre seus dados de acompanhamento de tempo a vários serviços.
Pré-requisitos
Antes de usar esse conector, você precisará de:
- Uma conta do Timeneye. Se você não tiver um, você pode se inscrever aqui.
Introdução
Configurar o conector:
- Abra o Power Platform e vá para a seção conectores.
- Pesquise o conector Timeneye.
- Autenticar usando o fluxo OAuth 2.0 quando solicitado.
Limitação de taxa
Para poder oferecer um serviço confiável a todos os nossos usuários e clientes, limitamos quantas solicitações podem ser executadas por token a cada 5 minutos.
Cada token tem um número limitado de solicitações (na tabela abaixo) que podem ser executadas em uma determinada janela de tempo. A contagem de solicitações é redefinida a cada 5 minutos.
O número de solicitações que podem ser executadas a cada 5 minutos muda com base em qual plano tem a conta do usuário, no momento da solicitação.
| Plano | Máximo de solicitações por 5 minutos |
|---|---|
| Gratuito | 500 |
| Negócios (qualquer camada)/PRO | 2000 |
Caso o limite seja atingido, as solicitações a seguir (para o token fornecido) receberão um 429 erro.
A resposta conterá os seguintes cabeçalhos: | Cabeçalho | Valor de exemplo | Descrição | |--|--|--| | X-RateLimit-Limit | 2000 | Quantas solicitações você pode fazer | | X-RateLimit-Remaining | 0 | Quantas solicitações restantes restam | | Retry-After | 177 | Indica quantos segundos esperar antes de fazer uma solicitação de acompanhamento.| | X-RateLimit-Reset | 1691677002 | Indica quando o limite é redefinido (carimbo de data/hora UNIX) |
Errors
Todos os nossos pontos de extremidade de API retornam um código de status HTTP 200 quando tudo funciona conforme o esperado, mas às vezes pode retornar um erro.
Nossas APIs retornam códigos de erro diferentes com base na causa da falha, desde parâmetros ausentes até erros de servidor do nosso lado.
Na tabela abaixo, você encontra uma lista de todos os nossos códigos de erro com uma descrição genérica da causa, caso o ponto de extremidade não retorne uma descrição do caso específico.
| Code | Meaning | Description |
|---|---|---|
| 400 | Solicitação incorreta | Um ou vários parâmetros necessários estão ausentes ou inválidos. |
| 401 | Desautorizado | O token de autorização está ausente, inválido ou expirado. |
| 403 | Proibido | A autenticação e a sintaxe da solicitação estão corretas, mas o recurso que você está tentando editar requer um nível de acesso que o usuário autorizado não tem. |
| 403 | Não encontrado | O recurso solicitado não está disponível. |
| 403 | Não encontrado | O recurso solicitado não está disponível. |
| 422 | Validation | Os parâmetros ou a carga passada não seguem a especificação necessária |
| 429 | Demasiados pedidos | Você atingiu o limite de taxa. |
| 500 | Erro interno do servidor | Havia um problema do nosso lado. |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar a relação de lista de Project-Tag |
Atualizar relação de lista de marcas de projeto |
| Atualizar Conta |
Atualiza uma conta |
| Atualizar Group-User relação |
Atualiza a relação entre um usuário e um grupo |
| Atualizar Project-Tag relação |
Atualizar relação de lista de marcas de projeto |
| Atualizar Project-User relação |
Atualiza a relação entre um projeto e um usuário |
| Atualizar um cliente |
Atualiza um cliente |
| Atualizar um grupo |
Atualizar um grupo |
| Atualizar um orçamento |
Atualiza um orçamento |
| Atualizar um projeto |
Atualiza um projeto |
| Atualizar um temporizador |
Atualiza um temporizador |
| Atualizar um Todo |
Atualiza um todo |
| Atualizar um usuário |
Atualiza um usuário |
| Atualizar uma categoria de fase |
Atualizar uma categoria de fase |
| Atualizar uma entrada |
Atualiza uma entrada |
| Atualizar uma fase |
Atualiza uma fase |
| Atualizar uma lista de marcas |
Atualiza uma lista de marcas |
| Atualizar uma lista todo |
Atualiza uma lista de marcas |
| Atualizar uma marca |
Atualiza uma marca |
| Criar Group-Project relação |
Anexar um projeto a um grupo |
| Criar Group-User relação |
Anexar um usuário a um grupo |
| Criar Project-Tag relação |
Criar Project-Tag relação de lista |
| Criar Project-User relação |
Anexar um usuário a um projeto |
| Criar relação de lista de Project-Tag |
Criar Project-Tag relação de lista |
| Criar um Avatar |
Cria um avatar |
| Criar um cliente |
Cria um cliente |
| Criar um grupo |
Criar Grupo |
| Criar um orçamento |
Cria um orçamento |
| Criar um projeto |
Cria um projeto |
| Criar um temporizador |
Cria um temporizador |
| Criar um Todo |
Criar um todo |
| Criar uma categoria de fase |
Cria uma categoria de fase |
| Criar uma entrada |
Cria uma entrada |
| Criar uma fase |
Criar uma nova fase |
| Criar uma lista de marcas |
Cria uma lista de marcas |
| Criar uma lista todo |
Criar uma lista de tarefas pendentes |
| Criar uma marca |
Cria uma marca |
| Excluir Group-Project relação |
Removido um projeto de um grupo |
| Excluir Group-User relação |
Removeu um usuário de um grupo |
| Excluir Project-Tag relação |
Remover relação de marca de projeto |
| Excluir Project-User relação |
Removeu um usuário de um projeto |
| Excluir relação de lista de Project-Tag |
Remover relação de lista de marcas de projeto |
| Excluir um cliente |
Exclui um cliente |
| Excluir um grupo |
Excluir um grupo |
| Excluir um orçamento |
Exclui um orçamento |
| Excluir um projeto |
Exclui um projeto |
| Excluir um temporizador |
Excluir um temporizador |
| Excluir um Todo |
Exclui um todo |
| Excluir um usuário |
Exclui um usuário |
| Excluir uma categoria de fase |
Excluir uma categoria de fase |
| Excluir uma entrada |
Excluir uma entrada |
| Excluir uma fase |
Exclui uma fase |
| Excluir uma lista de marcas |
Exclui uma lista de marcas |
| Excluir uma lista todo |
Exclui uma lista de tarefas pendentes |
| Excluir uma marca |
Exclui uma marca |
| Excluir uma sugestão de entrada |
Exclui uma sugestão de entrada |
| Fases de lista |
Listar todas as fases |
| Listar categorias de fase |
Obter a lista das categorias de fase |
| Listar clientes |
Obter lista de clientes |
| Listar Entradas |
Obter lista de entradas |
| Listar grupos |
Obter a lista de todos os grupos |
| Listar idiomas |
Obter lista de idiomas |
| Listar Listas de Marcas |
Obter listas de marcas |
| Listar Listas De Todos |
Obter uma lista de listas de tarefas pendentes |
| Listar moedas |
Obter lista de moedas |
| Listar orçamentos |
Obter lista de orçamentos |
| Listar países |
Obter lista de países |
| Listar projetos |
Obter uma lista de projetos |
| Listar sugestões de entrada |
Obter uma lista de sugestões de entrada para um determinado período de tempo |
| Listar Todos |
Obter uma lista de todos |
| Listar usuários |
Obter uma lista de usuários |
| Listar zonas |
Obter lista de zonas |
| Obter conta |
Obtém as informações sobre a conta de usuário |
| Obter entradas |
Obter uma entrada |
| Obter um cliente |
Obter um cliente |
| Obter um grupo |
Obter um grupo |
| Obter um orçamento |
Obter um orçamento |
| Obter um projeto |
Obtém um projeto |
| Obter um temporizador |
Obter um temporizador |
| Obter um Todo |
Obtém um único todo |
| Obter um usuário |
Obtém um único usuário |
| Obter uma categoria de fase |
Obter uma categoria de fase |
| Obter uma fase |
Obtém uma fase |
| Obter uma lista de marcas |
Obtém uma única lista de marcas |
| Obter uma lista todo |
Obtém uma única lista de tarefas pendentes |
| Obter uma marca |
Obter uma única marca |
| Tags de lista |
Obter lista de marcas |
| Temporizadores de Lista |
Obter lista de temporizadores |
Atualizar a relação de lista de Project-Tag
Atualizar relação de lista de marcas de projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
tag_list
|
tag_list | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de marcas neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para esta marca de lista neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de marcas neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para esta lista de marcas neste projeto |
|
|
required
|
required | boolean |
Atualizar Conta
Atualiza uma conta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
account_name
|
account_name | string |
O nome da conta, geralmente o nome da empresa. |
|
|
adminNewEntryForOthers
|
adminNewEntryForOthers | boolean |
Possibilidade de adicionar entradas em nome de outros usuários |
|
|
allow_password_login
|
allow_password_login | boolean |
Se o logon com email + senha é permitido ou não |
|
|
idp_cert
|
idp_cert | string |
Certificado do provedor de identidade (usado com o tipo = saml) |
|
|
idp_entity_id
|
idp_entity_id | string |
ID do provedor de identidade (usado com o tipo = saml) |
|
|
idp_metadata_url
|
idp_metadata_url | string |
ID do provedor de identidade (usado com o tipo = saml) |
|
|
idp_sso_url
|
idp_sso_url | string |
URL de Logon Único (usada com o tipo = saml) |
|
|
tipo
|
type | string |
Tipo de método de logon |
|
|
código de moeda
|
currencyCode | string |
Código da moeda usada |
|
|
enabled
|
enabled | boolean |
Se a automação de bloqueio de entrada está habilitada ou não |
|
|
intervalo
|
interval | string |
Intervalo do bloqueio de entrada |
|
|
interval_target
|
interval_target | number |
Entre 1 e 31 se o intervalo for mensal (o dia do mês), entre 0 e 6i se o intervalo for semanal |
|
|
memberAverageCost
|
memberAverageCost | number |
Indica o custo médio de mão-de-obra para os membros da conta |
|
|
showWorkingTime
|
showWorkingTime | boolean |
Se os usuários podem ou não ver seu tempo de trabalho em seu painel. (por exemplo, 7h de 8h) |
Atualizar Group-User relação
Atualiza a relação entre um usuário e um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
is_gm
|
is_gm | boolean |
Informa se o usuário é o gerente de grupo do grupo |
Atualizar Project-Tag relação
Atualizar relação de lista de marcas de projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
marca
|
tag | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para essa marca neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para essa marca neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para essa marca neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para essa marca neste projeto |
Atualizar Project-User relação
Atualiza a relação entre um projeto e um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
usuário
|
user | True | string | |
|
budget_minutes
|
budget_minutes | integer |
As atas orçadas para este usuário neste projeto |
|
|
hourly_rate
|
hourly_rate | number |
A taxa por hora para esse usuário neste projeto. Tem precedência sobre a taxa por hora no nível do projeto e a taxa por hora no nível da conta |
|
|
is_favorited
|
is_favorited | boolean |
Se o projeto é ou não favorito pelo usuário |
|
|
is_pm
|
is_pm | boolean |
Se o usuário é ou não o gerente de projeto do projeto |
Atualizar um cliente
Atualiza um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | True | string |
Cor usada em relatórios |
|
nome
|
name | True | string |
Cor usada em relatórios |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo |
|
color
|
color | string |
Cor usada em relatórios |
|
is_active
|
is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
name | string |
Nome do cliente |
Atualizar um grupo
Atualizar um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome do grupo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
group_id
|
group_id | integer |
Identificador exclusivo |
|
nome
|
name | string |
Nome do grupo |
Atualizar um orçamento
Atualiza um orçamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
budget_minutes
|
budget_minutes | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
|
intervalo
|
interval | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
|
recorrência
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador exclusivo do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: YYYY-MM-DD |
|
period_start
|
period_start | string |
Formato: YYYY-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual o orçamento pertence |
|
recorrência
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Atualizar um projeto
Atualiza um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
api_only
|
api_only | boolean |
Se o projeto pode ou não ser utilizável para acompanhar o tempo apenas usando as apis. |
|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo de um cliente ao qual o projeto pertence |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
descrição
|
description | string |
Uma descrição de texto do projeto |
|
|
hourly_rate
|
hourly_rate | number |
A cor usada para relatórios |
|
|
is_billable
|
is_billable | boolean |
Se o projeto pode ou não ser cobrado por hora |
|
|
is_public
|
is_public | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
|
nome
|
name | string |
O nome do projeto |
Atualizar um temporizador
Atualiza um temporizador
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
date
|
date | string |
Data do temporizador |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada da qual o temporizador é criado |
|
|
notas
|
notes | string |
Anotações sobre o temporizador |
|
|
origin_date
|
origin_date | string |
Formatar Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador exclusivo da fase à qual o temporizador pertence |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível da qual o temporizador é criado |
|
|
segundos
|
seconds | integer | ||
|
fonte
|
source | string |
Deve ser uma das integration_code disponíveis ou a "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem do temporizador |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem do temporizador |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
timer_status
|
timer_status | True | string | |
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou o temporizador |
Atualizar um Todo
Atualiza um todo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string | |
|
descrição
|
description | string |
Descrição do todo |
|
|
due_date
|
due_date | string |
Os dados pelos quais o todo deve ser concluído |
|
|
indexar
|
index | integer |
O índice do todo na lista (ordem) |
|
|
is_completed
|
is_completed | boolean |
Se o todo está ou não marcado como feito |
|
|
nome
|
name | string |
Título do todo |
|
|
priority
|
priority | string |
Se o todo está ou não marcado como feito |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual o todo pertence |
|
|
start_date
|
start_date | string |
A data em que o todo deve ser assumido no comando |
|
|
status
|
status | string |
O status atual do todo |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id a ser vinculada ao todo |
|
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo da lista todo à qual o todo pertence |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário atribuído ao todo |
|
|
user_ids
|
user_ids | array of integer |
Matriz de user_id que representa os usuários atribuídos ao todo |
Retornos
- response
- object
Atualizar um usuário
Atualiza um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
usuário
|
user | True | string | |
|
group_id
|
group_id | integer |
Identificador exclusivo do grupo ao qual o usuário pertence |
|
|
user_hourly_cost
|
user_hourly_cost | integer |
O custo por hora do usuário, expresso na moeda selecionada nas configurações da conta |
|
|
user_hourly_rate
|
user_hourly_rate | integer |
A taxa por hora do usuário, expressa na moeda selecionada nas configurações da conta |
|
|
working_time
|
working_time | integer |
Quantas horas o usuário geralmente está trabalhando em um dia |
|
|
workspace_access_level
|
workspace_access_level | string |
A função do usuário no Timeneye: proprietário, administrador ou membro |
Atualizar uma categoria de fase
Atualizar uma categoria de fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome da categoria de fase |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Atualizar uma entrada
Atualiza uma entrada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
entrada
|
entry | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
Faturado
|
billed | integer |
0 = Cobrança de entrada, 1 = Entrada cobrada, 2 = Entrada não faturável |
|
|
date
|
date | string |
Data da entrada |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada da qual a entrada é criada |
|
|
minutes
|
minutes | integer |
Quantidade de tempo controlado em minutos |
|
|
notas
|
notes | string |
Anotações sobre a entrada de hora |
|
|
origin_date
|
origin_date | string |
Formatar Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | integer |
Identificador exclusivo da fase à qual a entrada pertence |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto |
|
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível da qual a entrada é criada |
|
|
fonte
|
source | string |
Deve ser uma das integration_code disponíveis ou a "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem da entrada |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem da entrada |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
Atualizar uma fase
Atualiza uma fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
budget_minutes
|
budget_minutes | integer |
Quantidade de tempo orçado para a fase de tese. A soma do budget_minutes das fases não deve ser mais ral do que o tempo orçado para o projeto |
|
|
is_open
|
is_open | integer |
Se a fase é arquivada ou não |
|
|
nome
|
name | string |
O nome da fase |
|
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo da categoria de fase à qual a fase pertence |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a fase pertence |
Atualizar uma lista de marcas
Atualiza uma lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string | |
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da lista de marcas |
|
|
text_color
|
text_color | string |
A cor do texto usado para relatórios |
Atualizar uma lista todo
Atualiza uma lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string | |
|
color
|
color | True | string |
A cor usada para relatórios |
|
indexar
|
index | integer |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da lista de tarefas pendentes |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
criado_em
|
created_at | string |
Data e hora de criação |
|
indexar
|
index | integer |
O índice da lista todo no quadro (ordem) |
|
nome
|
name | string |
Nome da lista de tarefas pendentes |
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo |
|
updated_at
|
updated_at | string |
Data e hora atualizadas |
Atualizar uma marca
Atualiza uma marca
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
marca
|
tag | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da marca |
|
|
tag_list_id
|
tag_list_id | integer |
Identificador exclusivo da lista de marcas à qual a marca pertence |
Criar Group-Project relação
Anexar um projeto a um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
projeto
|
project | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Criar Group-User relação
Anexar um usuário a um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
is_gm
|
is_gm | boolean |
Informa se o usuário é o gerente de grupo do grupo |
Criar Project-Tag relação
Criar Project-Tag relação de lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
marca
|
tag | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para essa marca neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para essa marca neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para essa marca neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para essa marca neste projeto |
Criar Project-User relação
Anexar um usuário a um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
budget_minutes
|
budget_minutes | integer |
As atas orçadas para este usuário neste projeto |
|
|
hourly_rate
|
hourly_rate | number |
A taxa por hora para esse usuário neste projeto. Tem precedência sobre a taxa por hora no nível do projeto e a taxa por hora no nível da conta |
|
|
is_favorited
|
is_favorited | boolean |
Se o projeto é ou não favorito pelo usuário |
|
|
is_pm
|
is_pm | boolean |
Se o usuário é ou não o gerente de projeto do projeto |
Criar relação de lista de Project-Tag
Criar Project-Tag relação de lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
tag_list
|
tag_list | True | string | |
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de marcas neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para esta lista de marcas neste projeto |
|
|
budget_amount
|
budget_amount | number |
O valor orçado alocado para esta lista de marcas neste projeto |
|
|
budget_minutes
|
budget_minutes | integer |
Os minutos orçados alocados para esta lista de marcas neste projeto |
|
|
required
|
required | boolean |
Se a marca é necessária ou não para entradas de tempo deste projeto |
Criar um Avatar
Cria um avatar
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
imagem
|
image | True | binary |
Um arquivo que contém uma imagem |
|
user_id
|
user_id | integer |
Identificador do usuário que tem esse avatar |
|
|
account_id
|
account_id | integer |
Identificador da conta que tem esse avatar |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
account_id
|
account_id | integer |
Identificador da conta que tem esse avatar |
|
avatar_name
|
avatar_name | string |
nome de arquivo exclusivo |
|
avatar_url
|
avatar_url | string |
URL da imagem |
|
user_id
|
user_id | integer |
Identificador do usuário que tem esse avatar |
Criar um cliente
Cria um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | True | string |
Cor usada em relatórios |
|
nome
|
name | True | string |
Nome do cliente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do cliente
|
client_id | integer |
Identificador exclusivo |
|
color
|
color | string |
Cor usada em relatórios |
|
is_active
|
is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
name | string |
Nome do cliente |
Criar um grupo
Criar Grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
Nome do grupo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
group_id
|
group_id | integer |
Identificador exclusivo |
|
nome
|
name | string |
Nome do grupo |
Criar um orçamento
Cria um orçamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
budget_minutes
|
budget_minutes | True | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
|
|
project_id
|
project_id | True | integer |
Identificador do projeto ao qual o orçamento pertence |
|
recorrência
|
recurrence | True | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador exclusivo do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: YYYY-MM-DD |
|
period_start
|
period_start | string |
Formato: YYYY-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual o orçamento pertence |
|
recorrência
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Criar um projeto
Cria um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
api_only
|
api_only | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
|
ID do cliente
|
client_id | integer |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
|
color
|
color | True | string |
A cor usada para relatórios |
|
descrição
|
description | string |
Uma descrição de texto do projeto |
|
|
hourly_rate
|
hourly_rate | number |
A cor usada para relatórios |
|
|
is_billable
|
is_billable | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
|
is_public
|
is_public | boolean |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
|
nome
|
name | True | string |
O nome do projeto |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
api_only
|
api_only | integer |
Se o projeto pode ou não ser utilizável para acompanhar o tempo apenas usando as apis. |
|
ID do cliente
|
client_id | integer |
Identificador exclusivo de um cliente ao qual o projeto pertence |
|
color
|
color | string |
A cor usada para relatórios |
|
descrição
|
description | string |
Uma descrição de texto do projeto |
|
hourly_rate
|
hourly_rate | string |
A taxa geral por hora do projeto. Um hourly_rate específico pode ser definido na relação projeto-usuário |
|
is_active
|
is_active | integer |
Se o projeto está arquivado ou não |
|
is_billable
|
is_billable | integer |
Se o projeto pode ou não ser cobrado por hora |
|
is_public
|
is_public | integer |
Se o projeto é público ou não, o que significa que ele é visível por todos os usuários no workspace e todos podem acompanhar o tempo nele |
|
nome
|
name | string |
O nome do projeto |
|
project_id
|
project_id | integer |
Identificador exclusivo |
Criar um temporizador
Cria um temporizador
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
date
|
date | string |
Data do temporizador |
|
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada da qual o temporizador é criado |
|
|
notas
|
notes | string |
Anotações sobre o temporizador |
|
|
origin_date
|
origin_date | string |
Formatar Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador exclusivo da fase à qual o temporizador pertence |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível da qual o temporizador é criado |
|
|
segundos
|
seconds | integer | ||
|
fonte
|
source | string |
Deve ser uma das integration_code disponíveis ou a "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem do temporizador |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem do temporizador |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
timer_status
|
timer_status | True | string | |
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou o temporizador |
Retornos
- response
- object
Criar um Todo
Criar um todo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição do todo |
|
|
due_date
|
due_date | string |
Os dados pelos quais o todo deve ser concluído |
|
|
indexar
|
index | integer |
O índice do todo na lista (ordem) |
|
|
is_completed
|
is_completed | boolean |
Se o todo está ou não marcado como feito |
|
|
nome
|
name | True | string |
Título do todo |
|
priority
|
priority | string |
Se o todo está ou não marcado como feito |
|
|
start_date
|
start_date | string |
A data em que o todo deve ser assumido no comando |
|
|
status
|
status | string |
O status atual do todo |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id a ser vinculada ao todo |
|
|
todo_list_id
|
todo_list_id | True | integer |
Identificador exclusivo da lista todo à qual o todo pertence |
|
user_id
|
user_id | True | integer |
Identificador exclusivo do usuário atribuído ao todo |
|
user_ids
|
user_ids | array of integer |
Matriz de user_id que representa os usuários atribuídos ao todo |
Retornos
- response
- object
Criar uma categoria de fase
Cria uma categoria de fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da categoria de fase |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Criar uma entrada
Cria uma entrada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
Faturado
|
billed | integer |
0 = Cobrança de entrada, 1 = Entrada cobrada, 2 = Entrada não faturável |
|
|
date
|
date | True | string |
Data da entrada |
|
entry_suggestion_id
|
entry_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada da qual a entrada é criada |
|
|
minutes
|
minutes | True | integer |
Quantidade de tempo controlado em minutos |
|
notas
|
notes | string |
Anotações sobre a entrada de hora |
|
|
origin_date
|
origin_date | string |
Formatar Y-m-d necessário com repeatable_suggestion_id |
|
|
phase_id
|
phase_id | True | integer |
Identificador exclusivo da fase à qual a entrada pertence |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto |
|
repeatable_suggestion_id
|
repeatable_suggestion_id | integer |
Um identificador exclusivo da sugestão de entrada repetível da qual a entrada é criada |
|
|
fonte
|
source | string |
Deve ser uma das integration_code disponíveis ou a "consistência" |
|
|
source_text
|
source_text | string |
Um texto que descreve a origem da entrada |
|
|
source_url
|
source_url | string |
Um texto que descreve a origem da entrada |
|
|
tag_ids
|
tag_ids | array of integer |
Matriz de tag_id |
|
|
user_id
|
user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
Retornos
- response
- object
Criar uma fase
Criar uma nova fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
budget_minutes
|
budget_minutes | True | integer |
Quantidade de tempo orçado para a fase de tese. A soma do budget_minutes das fases não deve ser mais ral do que o tempo orçado para o projeto |
|
nome
|
name | True | string |
O nome da fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo da categoria de fase à qual a fase pertence |
|
|
project_id
|
project_id | True | integer |
Quantidade de tempo orçado para a fase de tese. A soma do budget_minutes das fases não deve ser mais ral do que o tempo orçado para o projeto |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_minutes
|
budget_minutes | integer |
Quantidade de tempo orçado para a fase de tese. A soma do budget_minutes das fases não deve ser mais ral do que o tempo orçado para o projeto |
|
is_open
|
is_open | integer |
Se a fase é arquivada ou não |
|
nome
|
name | string |
O nome da fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo da categoria de fase à qual a fase pertence |
|
phase_id
|
phase_id | integer |
Identificador exclusivo |
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a fase pertence |
Criar uma lista de marcas
Cria uma lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
color
|
color | string |
A cor usada para relatórios |
|
|
nome
|
name | string |
O nome da lista de marcas |
|
|
text_color
|
text_color | string |
A cor do texto usado para relatórios |
Criar uma lista todo
Criar uma lista de tarefas pendentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
color
|
color | True | string |
A cor usada para relatórios |
|
indexar
|
index | integer |
A cor usada para relatórios |
|
|
nome
|
name | True | string |
Nome da lista de tarefas pendentes |
|
project_id
|
project_id | True | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
criado_em
|
created_at | string |
Data e hora de criação |
|
indexar
|
index | integer |
O índice da lista todo no quadro (ordem) |
|
nome
|
name | string |
Nome da lista de tarefas pendentes |
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo |
|
updated_at
|
updated_at | string |
Data e hora atualizadas |
Criar uma marca
Cria uma marca
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
nome
|
name | True | string |
O nome da marca |
|
tag_list_id
|
tag_list_id | True | integer |
Identificador exclusivo da lista de marcas à qual a marca pertence |
Excluir Group-Project relação
Removido um projeto de um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
projeto
|
project | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir Group-User relação
Removeu um usuário de um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir Project-Tag relação
Remover relação de marca de projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
marca
|
tag | True | string |
Excluir Project-User relação
Removeu um usuário de um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir relação de lista de Project-Tag
Remover relação de lista de marcas de projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
tag_list
|
tag_list | True | string |
Excluir um cliente
Exclui um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um grupo
Excluir um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um orçamento
Exclui um orçamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um projeto
Exclui um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um temporizador
Excluir um temporizador
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um Todo
Exclui um todo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir um usuário
Exclui um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
usuário
|
user | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma categoria de fase
Excluir uma categoria de fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma entrada
Excluir uma entrada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
entrada
|
entry | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma fase
Exclui uma fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma lista de marcas
Exclui uma lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma lista todo
Exclui uma lista de tarefas pendentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma marca
Exclui uma marca
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
marca
|
tag | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Excluir uma sugestão de entrada
Exclui uma sugestão de entrada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
entry_suggestion
|
entry_suggestion | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Fases de lista
Listar todas as fases
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
enviar SMS
|
text | string |
Obter fases que contêm esse texto no nome |
|
|
ativo
|
active | boolean |
Obter apenas fases ativas ou inativas |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
project_id
|
project_id | integer |
Obter fases pertencentes a um projeto |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar categorias de fase
Obter a lista das categorias de fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
enviar SMS
|
text | string |
Cadeia de caracteres de pesquisa de texto completo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar clientes
Obter lista de clientes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
enviar SMS
|
text | string |
Pesquisa no nome do cliente |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de IDs do cliente para filtrar os resultados |
|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
ID do cliente
|
data.client_id | integer |
Identificador exclusivo |
|
color
|
data.color | string |
Cor usada em relatórios |
|
is_active
|
data.is_active | boolean |
Se o cliente está ou não arquivado |
|
nome
|
data.name | string |
Nome do cliente |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
próximo
|
links.next | string | |
|
Prev
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
from
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
ativo
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
url
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar Entradas
Obter lista de entradas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de IDs de usuário para filtrar os resultados |
|
|
entry_ids[]
|
entry_ids[] | string |
Uma lista separada por vírgulas de IDs de entrada para filtrar os resultados |
|
|
project_ids[]
|
project_ids[] | string |
Uma lista separada por vírgulas de IDs do projeto para filtrar os resultados |
|
|
phase_ids[]
|
phase_ids[] | string |
Uma lista separada por vírgulas de IDs de fase para filtrar os resultados |
|
|
client_ids[]
|
client_ids[] | string |
Uma lista separada por vírgulas de IDs do cliente para filtrar os resultados |
|
|
group_ids[]
|
group_ids[] | string |
Uma lista separada por vírgulas de IDs de grupo para filtrar os resultados |
|
|
category_ids[]
|
category_ids[] | string |
Uma lista separada por vírgulas de IDs de categoria de fase para filtrar os resultados |
|
|
tag_list_ids[]
|
tag_list_ids[] | string |
Uma lista separada por vírgulas de IDs de lista de marcas para filtrar os resultados |
|
|
tag_ids[]
|
tag_ids[] | string |
Uma lista separada por vírgulas de IDs de marca para filtrar os resultados |
|
|
billed_status
|
billed_status | integer |
Obtenha apenas a entrada que tenha um determinado status cobrado: 0: Não faturado 1: Cobrado 2: Não faturável 3: Faturável |
|
|
período de tempo
|
timeframe | string |
Obter somente as entradas em um determinado período de tempo |
|
|
date_from
|
date_from | string |
Obter somente as entradas que têm ralador de data ou igual a esta data |
|
|
date_to
|
date_to | string |
Obter somente as entradas que têm data menor ou igual a esta data |
|
|
enviar SMS
|
text | string |
Obter entradas que contêm esse texto nas anotações |
|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
Faturado
|
data.billed | integer |
Indica se a entrada foi cobrada |
|
ID do cliente
|
data.client_id | integer |
Identificador exclusivo do cliente que pertence ao projeto da entrada |
|
custar
|
data.cost | string |
O custo monetário da entrada de tempo com base no custo por hora do usuário que a criou |
|
created_date
|
data.created_date | string |
Data e hora da criação |
|
entry_date
|
data.entry_date | string |
Data da entrada |
|
entry_id
|
data.entry_id | integer |
Identificador exclusivo |
|
entry_minutes
|
data.entry_minutes | integer |
Quantidade de tempo controlado em minutos |
|
bloqueado
|
data.locked | integer |
Se a entrada está bloqueada ou não |
|
locked_by_apionly
|
data.locked_by_apionly | integer |
Se a entrada está bloqueada por restrição somente em um aplicativo de terceiros |
|
locked_by_date
|
data.locked_by_date | integer |
Se a entrada está bloqueada ou não por data |
|
locked_by_membership
|
data.locked_by_membership | integer |
Se a entrada está bloqueada ou não por associação |
|
notas
|
data.notes | string |
Anotações sobre a entrada de hora |
|
phase_category_id
|
data.phase_category_id | integer |
Identificador exclusivo da categoria de fase à qual a fase da entrada pertence |
|
phase_id
|
data.phase_id | integer |
Identificador exclusivo da fase à qual a entrada pertence |
|
lucro
|
data.profit | string |
A diferença entre a receita e o custo |
|
project_id
|
data.project_id | integer |
Identificador exclusivo do projeto |
|
renda
|
data.revenue | string |
A receita monetária da entrada de tempo com base na taxa geral por hora, a do projeto. |
|
fonte
|
data.source | string |
Indica a origem da entrada (se houver) |
|
source_data
|
data.source_data | string |
Dados adicionais da origem |
|
source_id
|
data.source_id | string |
Um identificador exclusivo da origem da entrada |
|
source_text
|
data.source_text | string |
Um texto que descreve a origem da entrada |
|
source_url
|
data.source_url | string |
Uma URL para a origem da entrada |
|
suggested_phase_id
|
data.suggested_phase_id | string |
Um identificador opcional de uma fase sugerida se a entrada for criada a partir de uma EntrySuggestion |
|
suggested_project_id
|
data.suggested_project_id | string |
Um identificador opcional de um projeto sugerido se a entrada for criada a partir de uma EntrySuggestion |
|
todo_id
|
data.todo_id | string |
O identificador exclusivo de um todo vinculado à entrada de hora |
|
updated_date
|
data.updated_date | string |
Atualização de data e hora |
|
user_id
|
data.user_id | integer |
Identificador exclusivo do usuário que criou a entrada |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
próximo
|
links.next | string | |
|
Prev
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
from
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
ativo
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
url
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar grupos
Obter a lista de todos os grupos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar idiomas
Obter lista de idiomas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
language_code
|
language_code | string |
Identificador exclusivo |
|
nome
|
name | string |
Nome do idioma |
Listar Listas de Marcas
Obter listas de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Obter listas de marcas pertencentes a um projeto |
|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar Listas De Todos
Obter uma lista de listas de tarefas pendentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual a lista todo pertence |
|
|
load[]
|
load[] | string |
Uma lista separada por vírgulas de entidades a serem carregadas. '"todos" é o único valor aceito' |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
items
|
data | object | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar moedas
Obter lista de moedas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
currency_code
|
currency_code | string | |
|
nome
|
name | string |
Listar orçamentos
Obter lista de orçamentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador do projeto ao qual o orçamento pertence |
|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
budget_id
|
data.budget_id | integer |
Identificador exclusivo do orçamento |
|
budget_minutes
|
data.budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
data.interval | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
is_active
|
data.is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
data.period_end | string |
Formato: YYYY-MM-DD |
|
period_start
|
data.period_start | string |
Formato: YYYY-MM-DD |
|
project_id
|
data.project_id | integer |
Identificador do projeto ao qual o orçamento pertence |
|
recorrência
|
data.recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
|
primeiro
|
links.first | string | |
|
último
|
links.last | string | |
|
próximo
|
links.next | string | |
|
Prev
|
links.prev | string | |
|
current_page
|
meta.current_page | integer | |
|
from
|
meta.from | integer | |
|
last_page
|
meta.last_page | integer | |
|
links
|
meta.links | array of object | |
|
ativo
|
meta.links.active | boolean | |
|
etiqueta
|
meta.links.label | string | |
|
url
|
meta.links.url | string | |
|
caminho
|
meta.path | string | |
|
per_page
|
meta.per_page | integer | |
|
para
|
meta.to | integer | |
|
total
|
meta.total | integer |
Listar países
Obter lista de países
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
company_tax
|
company_tax | string | |
|
country_code
|
country_code | string | |
|
nome
|
name | string | |
|
private_tax
|
private_tax | string | |
|
vat_required
|
vat_required | integer |
Listar projetos
Obter uma lista de projetos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
público
|
public | boolean |
Obter somente projetos públicos |
|
|
ativo
|
active | boolean |
Obter somente projetos ativos |
|
|
Faturável
|
billable | boolean |
Obter somente projetos faturáveis |
|
|
load[]
|
load[] | string |
Uma lista separada por vírgulas de entidades a serem carregadas. Valores possíveis: usuários, orçamento, fases, grupos |
|
|
enviar SMS
|
text | string |
Pesquisa de texto completo |
|
|
ID do cliente
|
client_id | integer |
Obter projetos pertencentes a um cliente identificado por esse parâmetro |
|
|
user_id
|
user_id | integer |
Projeto de pesquisa no qual o usuário está na equipe |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar sugestões de entrada
Obter uma lista de sugestões de entrada para um determinado período de tempo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
no_paginate
|
no_paginate | boolean |
Obter uma lista completa de sugestões sem paginar os resultados |
|
|
período de tempo
|
timeframe | string |
Obter apenas as sugestões em um determinado período de tempo |
|
|
date_from
|
date_from | string |
Obtenha apenas as sugestões que têm ralador de data ou igual a esta data |
|
|
date_to
|
date_to | string |
Obter apenas as sugestões que têm data menor ou igual a esta data |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
aceito
|
data.accepted | integer |
Se a sugestão é ou não aceita uma transformação em uma entrada |
|
created_datetime
|
data.created_datetime | string |
Data e hora da criação da sugestão |
|
entry_date
|
data.entry_date | string |
Data sugerida |
|
entry_minutes
|
data.entry_minutes | integer |
Quantidade sugerida de tempo em minutos |
|
entry_suggestion_id
|
data.entry_suggestion_id | integer |
Identificador exclusivo |
|
notas
|
data.notes | string |
Anotações relacionadas à origem da sugestão |
|
phase_id
|
data.phase_id | integer |
Identificador exclusivo da fase sugerida |
|
phase_name
|
data.phase_name | string |
Nome da fase sugerida |
|
project_id
|
data.project_id | integer |
Identificador exclusivo do projeto sugerido |
|
project_name
|
data.project_name | string |
Nome do projeto sugerido |
|
fonte
|
data.source | string |
Identificador de origem |
|
source_data
|
data.source_data | string |
Outros dados relacionados à origem |
|
source_id
|
data.source_id | string |
Identificador exclusivo da origem |
|
source_text
|
data.source_text | string |
Texto relacionado à origem |
|
source_url
|
data.source_url | string |
URL da origem da sugestão |
|
todo_id
|
data.todo_id | integer | |
|
user_id
|
data.user_id | integer |
Identificador exclusivo do usuário que possui a sugestão |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar Todos
Obter uma lista de todos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
project_id
|
project_id | integer |
Identificador exclusivo do projeto ao qual o todo pertence |
|
|
todo_list_id
|
todo_list_id | integer |
Identificador exclusivo de uma lista de tarefas pendentes |
|
|
user_ids[]
|
user_ids[] | string |
Uma lista separada por vírgulas de identificadores exclusivos do usuário atribuídos ao todos |
|
|
priority[]
|
priority[] | string |
Uma lista de prioridades separada por vírgulas: valores permitidos: baixo, médio, alto |
|
|
status[]
|
status[] | string |
Uma lista separada por vírgulas de status. Valores permitidos: todo, in_progress, concluído |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
items
|
data | object | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar usuários
Obter uma lista de usuários
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
enviar SMS
|
text | string |
Pesquisa de texto completo |
|
|
nome
|
name | string |
Pesquisar os usuários pelo nome |
|
|
email
|
string |
Pesquisar os usuários por email |
||
|
status
|
status | string |
Pesquisar os usuários por status |
|
|
ativo
|
active | boolean |
Pesquisar os usuários por status ativo |
|
|
group_ids[]
|
group_ids[] | string |
Uma lista separada por vírgulas de IDs de grupo a serem filtradas por |
|
|
group_id
|
group_id | string |
Pesquisar os usuários que pertencem a um grupo |
|
|
member_ids[]
|
member_ids[] | string |
Uma lista separada por vírgulas de IDs de usuário a serem filtradas por |
|
|
project_ids[]
|
project_ids[] | string |
Uma lista separada por vírgulas de IDs de projeto a serem filtradas por |
|
|
client_ids[]
|
client_ids[] | string |
Uma lista separada por vírgulas de IDs de cliente a serem filtradas por |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Listar zonas
Obter lista de zonas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
country_code
|
country_code | string |
Código do país ao qual a zona pertence |
|
nome
|
name | string |
Nome do fuso horário |
|
zone_id
|
zone_id | integer |
Identificador exclusivo |
Obter conta
Obtém as informações sobre a conta de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
Obter entradas
Obter uma entrada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
entrada
|
entry | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
- response
- object
Obter um cliente
Obter um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
cliente
|
client | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Obter um grupo
Obter um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
agrupar
|
group | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Obter um orçamento
Obter um orçamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
orçamento
|
budget | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
budget_id
|
budget_id | integer |
Identificador exclusivo do orçamento |
|
budget_minutes
|
budget_minutes | integer |
A quantidade de minutos que o orçamento representa |
|
intervalo
|
interval | integer |
Dia de redefinição do orçamento: 1 a 31 se o orçamento for mensal, de 0 a 6 se o orçamento for semanal |
|
is_active
|
is_active | integer |
Se o orçamento está ativo ou não |
|
period_end
|
period_end | string |
Formato: YYYY-MM-DD |
|
period_start
|
period_start | string |
Formato: YYYY-MM-DD |
|
project_id
|
project_id | integer |
Identificador do projeto ao qual o orçamento pertence |
|
recorrência
|
recurrence | integer |
Recorrência do orçamento: 0 = sem recorrência, 1 = semanal, 2 = mensal |
Obter um projeto
Obtém um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
projeto
|
project | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Obter um temporizador
Obter um temporizador
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
temporizador
|
timer | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Obter um Todo
Obtém um único todo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo
|
todo | True | string |
Retornos
- response
- object
Obter um usuário
Obtém um único usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
usuário
|
user | True | string |
Obter uma categoria de fase
Obter uma categoria de fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
phase_category
|
phase_category | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
color
|
color | string |
A cor usada para relatórios |
|
nome
|
name | string |
Nome da categoria de fase |
|
phase_category_id
|
phase_category_id | integer |
Identificador exclusivo |
Obter uma fase
Obtém uma fase
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
fase
|
phase | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Obter uma lista de marcas
Obtém uma única lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
tag_list
|
tag_list | True | string |
Obter uma lista todo
Obtém uma única lista de tarefas pendentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
todo_list
|
todo_list | True | string |
Obter uma marca
Obter uma única marca
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
marca
|
tag | True | string | |
|
Aceitar
|
Accept | string |
aplicativo/json |
Tags de lista
Obter lista de marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
aplicativo/json |
|
|
nome
|
name | string |
Pesquisa de texto no nome |
|
|
tag_list_id
|
tag_list_id | integer |
ID de um TagList |
|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of object | |
|
color
|
data.color | string |
A cor usada para relatórios |
|
is_active
|
data.is_active | integer |
Se a marca está ou não arquivada |
|
nome
|
data.name | string |
O nome da marca |
|
tag_id
|
data.tag_id | integer |
Identificador exclusivo |
|
tag_list_id
|
data.tag_list_id | integer |
Identificador exclusivo da lista de marcas à qual a marca pertence |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Temporizadores de Lista
Obter lista de temporizadores
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
página
|
page | integer |
A página exibida no momento |
|
|
per_page
|
per_page | integer |
Quantos itens por página |
|
|
sort_by
|
sort_by | string |
O atributo a ser classificado por |
|
|
direção
|
direction | string |
A direção de classificação |
|
|
date_from
|
date_from | string |
Obter somente os temporizadores que têm ralador de data ou igual a esta data |
|
|
date_to
|
date_to | string |
Obter somente os temporizadores que têm data menor ou igual a esta data |
|
|
Aceitar
|
Accept | string |
aplicativo/json |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
current_page
|
current_page | integer | |
|
dados
|
data | array of | |
|
first_page_url
|
first_page_url | string | |
|
from
|
from | integer | |
|
last_page
|
last_page | integer | |
|
last_page_url
|
last_page_url | string | |
|
next_page_url
|
next_page_url | string | |
|
caminho
|
path | string | |
|
per_page
|
per_page | integer | |
|
prev_page_url
|
prev_page_url | string | |
|
para
|
to | integer | |
|
total
|
total | integer |
Definições
objeto
Esse é o tipo 'object'.