Update client budget with the Everhour API
Creates or replaces the budget of a client. Send the whole budget, because partial updates are not supported. Reaching the threshold emails the admins of the team.
- Identifier
- everhour_update_client_budget
The request
POST https://connect.reportei.com/api/tools/everhour_update_client_budget/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"client_id": 1,
"type": "money",
"budget": 1,
"period": "general"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | integer | Yes | Id of the client, from List clients. |
| type | string | Yes | money counts billable amounts, time counts hours, and costs counts money at the hourly cost of each member.Values: money, time, costs |
| budget | number | Yes | Budget value: cents for money and costs, such as 500000 for 5,000.00, or seconds for time, such as 36000 for 10 hours. |
| period | string | Yes | general is a one-off budget; the others restart every period.Values: general, monthly, weekly, daily, quarterly, yearly |
| appliedFrom | string | No | Day the budget starts counting, in YYYY-MM-DD. Only for the general period. |
| disallowOverbudget | boolean | No | true stops time from being tracked over the budget. |
| excludeUnbillableTime | boolean | No | true leaves non-billable time out of the usage. |
| excludeExpenses | boolean | No | true leaves expenses out of the usage. |
| threshold | number | No | Usage percentage that emails the admins of the team. |
Supported connections
Your customer connects their Everhour account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/everhour_update_client_budget. It becomes your agent's tool definition with no conversion.
Other Everhour tools
- List clientsGETLists the clients of the team in a single response, with the ids of their projects and the budget with its usage in progress. Money is in cents and time in seconds.
- Create clientPOSTCreates a client. Names are not deduplicated, so check List clients first. Link the projects whose time is invoiced to this client.
- Update clientPUTChanges a client. Only the fields sent are changed. To link a new project, send the complete projects list, including the ids already linked that List clients shows.
- List projectsGETLists the projects the user has access to, with the client id, billing type, rates and budget with its usage. Ids carry the integration prefix, such as as:1234567890 for Asana or ev:1234567890 for projects created in Everhour. Pages start at 1, and a page shorter than limit is the last one.
- Search tasksGETSearches tasks by name in all projects, or in one project. Returns the task ids, such as ev:3000010034, that the time record tools ask for, with the project ids, status and time totals in seconds.
- List time recordsGETLists the time records of the whole team in a date range, both days included. Without from and to it returns only today. Each record has the time in seconds, the user id, whose name comes from List users, the date, the task with its project ids, and isInvoiced. A page shorter than limit is the last one.
- Create time recordPOSTLogs time on a task for a day. A user has at most one record per task and day: sending the same user, task and date again updates the duration of that record instead of creating another one.
- Update time recordPUTChanges a time record by its id. time is required in every call, so send the current duration to keep it.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
