BambooHR ACTION
Adjust Time Off Balance
Create a balance adjustment for an employee's time off type, recorded as an override history item. Cannot adjust discretionary (unlimited) time off types. Use Get Time Off Balance to check current balances and List Time Off Types for a valid type ID first. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's BambooHR account once, then configure and run Adjust Time Off Balance from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "bamboohr-adjust-time-off-balance",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
bamboohr: { authProvisionId: "apn_xxxxxxx" },
employeeId: "Employee ID",
timeOffTypeId: "Time Off Type ID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "bamboohr-adjust-time-off-balance",
"configured_props": {
"bamboohr": { "authProvisionId": "apn_xxxxxxx" },
"employeeId": "Employee ID",
"timeOffTypeId": "Time Off Type ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "bamboohr",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "bamboohr-adjust-time-off-balance",
arguments: {
employeeId: "Employee ID",
timeOffTypeId: "Time Off Type ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
employeeId Employee ID | string | The employee whose balance to adjust, e.g. 100. Run Get Employees Directory to discover IDs. Required |
timeOffTypeId Time Off Type ID | string | The time off type to adjust the balance for, e.g. 5. Run List Time Off Types to discover IDs; discretionary types cannot be adjusted. Required |
date Date | string | The date the adjustment should be recorded in history, in YYYY-MM-DD format, e.g. 2026-01-15. Required |
amount Amount | string | The amount to adjust the balance by, measured in the time off type's own unit — run List Time Off Types to confirm whether this type is days or hours before choosing a value (e.g. 1 to add one full day for a days type, or 8 to add a full day for an hours type). Use a negative number to subtract, e.g. -4. Required |
note Note | string | Optional note to show in the balance history. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- bamboohr-adjust-time-off-balance
- Version
- 0.0.1
- App
- BambooHR
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗