createTestClock creates an isolated, disposable simulation scenario.
Use with an AI agent
Export this page as Markdown or bundle it with a task for your agent.
Try a task
Preview the prompt that will be copied
Reference
Authentication: bearer token required (see how to get a token)
createTestClock creates an isolated, disposable simulation scenario.
Authentication: required. The clock is owned by the authenticated identity and
expires after seven days. Its data stays outside the ordinary account, transaction,
goal, and bank-connection collections. Transactions and goal contributions
appear as the clock advances; no bank request is sent.
Parameters:
- frozenTime (RFC 3339 timestamp, optional): initial simulated time; defaults to now.
- transactions (array, optional): up to 100 entries. Each needs an RFC 3339 at
between frozenTime and maxTime, a 1–120 character name, a positive amount up
to 1,000,000,000, a three-letter uppercase currency code, and type INCOME or
EXPENSE. Category is optional and limited to 80 characters.
- goals (array, optional): up to 25 goals with a 1–120 character name and a
positive targetAmount up to 1,000,000,000. initialAmount defaults to zero
and cannot exceed targetAmount. Each goal accepts up to 100 positive
contributions, each up to 1,000,000,000, scheduled between frozenTime and
maxTime.
Time range: frozenTime must be within ten years of now. maxTime is ten years
after frozenTime. Event times outside that range are rejected.
Returns: clock ID, frozen time, visible transactions, pending transactions, and
goal progress with posted and upcoming contributions.