{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:pocketsmith/get-accounts-id":{"get":{"operationId":"finance_pocketsmith_get_accounts_id","summary":"Get account","description":"GET /accounts/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the account.","schema":{"type":"integer","description":"The unique identifier of the account."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-accounts-id":{"post":{"operationId":"finance_pocketsmith_put_accounts_id","summary":"Update account","description":"PUT /accounts/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the account."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-accounts-id":{"post":{"operationId":"finance_pocketsmith_delete_accounts_id","summary":"Delete account","description":"DELETE /accounts/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the account."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-accounts-id-transactions":{"get":{"operationId":"finance_pocketsmith_get_accounts_id_transactions","summary":"List transactions in account","description":"GET /accounts/{id}/transactions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the account.","schema":{"type":"integer","description":"The unique identifier of the account."},"example":42},{"name":"start_date","in":"query","required":false,"description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…","schema":{"type":"string","description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…"},"example":"2025-10-15T13:51:08.354Z"},{"name":"end_date","in":"query","required":false,"description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date.","schema":{"type":"string","description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date."},"example":"2025-10-15T13:51:08.354Z"},{"name":"updated_since","in":"query","required":false,"description":"Limit to transactions updated since an ISO 8601 timestamp.","schema":{"type":"string","description":"Limit to transactions updated since an ISO 8601 timestamp."},"example":"2025-10-15T13:51:08.354Z"},{"name":"uncategorised","in":"query","required":false,"description":"Limit to uncategorised transactions.","schema":{"type":"integer","description":"Limit to uncategorised transactions."},"example":1},{"name":"type","in":"query","required":false,"description":"Limit to transactions of this type.","schema":{"type":"string","enum":["debit","credit"],"description":"Limit to transactions of this type."},"example":"debit"},{"name":"needs_review","in":"query","required":false,"description":"Limit to transactions that need to be reviewed.","schema":{"type":"integer","description":"Limit to transactions that need to be reviewed."},"example":1},{"name":"search","in":"query","required":false,"description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…","schema":{"type":"string","description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…"},"example":"Paypal"},{"name":"page","in":"query","required":false,"description":"Choose a particular page of the results.","schema":{"type":"integer","description":"Choose a particular page of the results."},"example":3}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-attachments-id":{"get":{"operationId":"finance_pocketsmith_get_attachments_id","summary":"Get attachment","description":"GET /attachments/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the attachment.","schema":{"type":"integer","description":"The unique identifier of the attachment."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-attachments-id":{"post":{"operationId":"finance_pocketsmith_put_attachments_id","summary":"Update attachment","description":"PUT /attachments/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the attachment."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-attachments-id":{"post":{"operationId":"finance_pocketsmith_delete_attachments_id","summary":"Delete attachment","description":"DELETE /attachments/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the attachment."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-categories-id":{"get":{"operationId":"finance_pocketsmith_get_categories_id","summary":"Get category","description":"GET /categories/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the category.","schema":{"type":"integer","description":"The unique identifier of the category."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-categories-id":{"post":{"operationId":"finance_pocketsmith_put_categories_id","summary":"Update category","description":"PUT /categories/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the category."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-categories-id":{"post":{"operationId":"finance_pocketsmith_delete_categories_id","summary":"Delete category","description":"DELETE /categories/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the category."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-categories-id-category-rules":{"post":{"operationId":"finance_pocketsmith_post_categories_id_category_rules","summary":"Create category rule in category","description":"POST /categories/{id}/category_rules","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the category."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-categories-id-transactions":{"get":{"operationId":"finance_pocketsmith_get_categories_id_transactions","summary":"List transactions in categories","description":"GET /categories/{id}/transactions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"A comma-separated list of category IDs.","schema":{"type":"string","description":"A comma-separated list of category IDs."},"example":"42,43"},{"name":"start_date","in":"query","required":false,"description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…","schema":{"type":"string","description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…"},"example":"2025-10-15T13:51:08.355Z"},{"name":"end_date","in":"query","required":false,"description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date.","schema":{"type":"string","description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date."},"example":"2025-10-15T13:51:08.355Z"},{"name":"updated_since","in":"query","required":false,"description":"Limit to transactions updated since an ISO 8601 timestamp.","schema":{"type":"string","description":"Limit to transactions updated since an ISO 8601 timestamp."},"example":"2025-10-15T13:51:08.355Z"},{"name":"uncategorised","in":"query","required":false,"description":"Limit to uncategorised transactions.","schema":{"type":"integer","description":"Limit to uncategorised transactions."},"example":1},{"name":"type","in":"query","required":false,"description":"Limit to transactions of this type.","schema":{"type":"string","enum":["debit","credit"],"description":"Limit to transactions of this type."},"example":"debit"},{"name":"needs_review","in":"query","required":false,"description":"Limit to transactions that need to be reviewed.","schema":{"type":"integer","description":"Limit to transactions that need to be reviewed."},"example":1},{"name":"search","in":"query","required":false,"description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…","schema":{"type":"string","description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…"},"example":"Paypal"},{"name":"page","in":"query","required":false,"description":"Choose a particular page of the results.","schema":{"type":"integer","description":"Choose a particular page of the results."},"example":3}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-currencies":{"get":{"operationId":"finance_pocketsmith_get_currencies","summary":"List currencies","description":"GET /currencies","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-currencies-id":{"get":{"operationId":"finance_pocketsmith_get_currencies_id","summary":"Get currency","description":"GET /currencies/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the currency.","schema":{"type":"string","description":"The unique identifier of the currency."},"example":"nzd"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-events-id":{"get":{"operationId":"finance_pocketsmith_get_events_id","summary":"Get event","description":"GET /events/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the event.","schema":{"type":"string","description":"The unique identifier of the event."},"example":"42-1601942400"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-events-id":{"post":{"operationId":"finance_pocketsmith_put_events_id","summary":"Update event","description":"PUT /events/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the event."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-events-id":{"post":{"operationId":"finance_pocketsmith_delete_events_id","summary":"Delete event","description":"DELETE /events/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","behaviour"],"properties":{"id":{"type":"string","description":"The unique identifier of the event."},"behaviour":{"type":"string","enum":["one","forward","all"],"description":"Whether the delete applies only to this event, to all events within the series from this event or to all events within the series."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-institutions-id":{"get":{"operationId":"finance_pocketsmith_get_institutions_id","summary":"Get institution","description":"GET /institutions/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the institution.","schema":{"type":"integer","description":"The unique identifier of the institution."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-institutions-id":{"post":{"operationId":"finance_pocketsmith_put_institutions_id","summary":"Update institution","description":"PUT /institutions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the institution."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-institutions-id":{"post":{"operationId":"finance_pocketsmith_delete_institutions_id","summary":"Delete institution","description":"DELETE /institutions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the institution."},"merge_into_institution_id":{"type":"integer","description":"The unique identifier of the institution to merge into."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-institutions-id-accounts":{"get":{"operationId":"finance_pocketsmith_get_institutions_id_accounts","summary":"List accounts in institution","description":"GET /institutions/{id}/accounts","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the institution.","schema":{"type":"integer","description":"The unique identifier of the institution."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-me":{"get":{"operationId":"finance_pocketsmith_get_me","summary":"Get the authorised user","description":"GET /me","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-scenarios-id-events":{"get":{"operationId":"finance_pocketsmith_get_scenarios_id_events","summary":"List events in scenario.","description":"GET /scenarios/{id}/events","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the scenario.","schema":{"type":"integer","description":"The unique identifier of the scenario."},"example":42},{"name":"start_date","in":"query","required":true,"description":"Return the events from and including this date.","schema":{"type":"string","description":"Return the events from and including this date."},"example":"2025-10-15T13:51:08.355Z"},{"name":"end_date","in":"query","required":true,"description":"Return the events until and including this date.","schema":{"type":"string","description":"Return the events until and including this date."},"example":"2025-10-15T13:51:08.355Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-scenarios-id-events":{"post":{"operationId":"finance_pocketsmith_post_scenarios_id_events","summary":"Create event in scenario","description":"POST /scenarios/{id}/events","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the scenario."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-time-zones":{"get":{"operationId":"finance_pocketsmith_get_time_zones","summary":"List time zones","description":"GET /time_zones","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-transaction-accounts-id":{"get":{"operationId":"finance_pocketsmith_get_transaction_accounts_id","summary":"Get transaction account","description":"GET /transaction_accounts/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the transaction account.","schema":{"type":"integer","description":"The unique identifier of the transaction account."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-transaction-accounts-id":{"post":{"operationId":"finance_pocketsmith_put_transaction_accounts_id","summary":"Update transaction account","description":"PUT /transaction_accounts/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the transaction account."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-transaction-accounts-id-transactions":{"get":{"operationId":"finance_pocketsmith_get_transaction_accounts_id_transactions","summary":"List transactions in transaction account","description":"GET /transaction_accounts/{id}/transactions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the transaction account.","schema":{"type":"integer","description":"The unique identifier of the transaction account."},"example":42},{"name":"start_date","in":"query","required":false,"description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…","schema":{"type":"string","description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…"},"example":"2025-10-15T13:51:08.355Z"},{"name":"end_date","in":"query","required":false,"description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date.","schema":{"type":"string","description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date."},"example":"2025-10-15T13:51:08.355Z"},{"name":"updated_since","in":"query","required":false,"description":"Limit to transactions updated since an ISO 8601 timestamp.","schema":{"type":"string","description":"Limit to transactions updated since an ISO 8601 timestamp."},"example":"2025-10-15T13:51:08.355Z"},{"name":"uncategorised","in":"query","required":false,"description":"Limit to uncategorised transactions.","schema":{"type":"integer","description":"Limit to uncategorised transactions."},"example":1},{"name":"type","in":"query","required":false,"description":"Limit to transactions of this type.","schema":{"type":"string","enum":["debit","credit"],"description":"Limit to transactions of this type."},"example":"debit"},{"name":"needs_review","in":"query","required":false,"description":"Limit to transactions that need to be reviewed.","schema":{"type":"integer","description":"Limit to transactions that need to be reviewed."},"example":1},{"name":"search","in":"query","required":false,"description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…","schema":{"type":"string","description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…"},"example":"Paypal"},{"name":"page","in":"query","required":false,"description":"Choose a particular page of the results.","schema":{"type":"integer","description":"Choose a particular page of the results."},"example":3}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-transaction-accounts-id-transactions":{"post":{"operationId":"finance_pocketsmith_post_transaction_accounts_id_transactions","summary":"Create a transaction in transaction account","description":"POST /transaction_accounts/{id}/transactions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the transaction account."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-transactions-id":{"get":{"operationId":"finance_pocketsmith_get_transactions_id","summary":"Get a transaction","description":"GET /transactions/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the transaction.","schema":{"type":"integer","description":"The unique identifier of the transaction."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-transactions-id":{"post":{"operationId":"finance_pocketsmith_put_transactions_id","summary":"Update a transaction","description":"PUT /transactions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the transaction."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-transactions-id":{"post":{"operationId":"finance_pocketsmith_delete_transactions_id","summary":"Delete transaction","description":"DELETE /transactions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the transaction."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-transactions-id-attachments":{"get":{"operationId":"finance_pocketsmith_get_transactions_id_attachments","summary":"List attachments in transaction","description":"GET /transactions/{id}/attachments","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the transaction.","schema":{"type":"integer","description":"The unique identifier of the transaction."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-transactions-id-attachments":{"post":{"operationId":"finance_pocketsmith_post_transactions_id_attachments","summary":"Assigns attachment to transaction","description":"POST /transactions/{id}/attachments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the transaction."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-transactions-transaction-id-attachments-attachment-id":{"post":{"operationId":"finance_pocketsmith_delete_transactions_transaction_id_attachments_attachment_id","summary":"Unassigns attachment in transaction","description":"DELETE /transactions/{transaction_id}/attachments/{attachment_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transaction_id","attachment_id"],"properties":{"transaction_id":{"type":"integer","description":"The unique identifier of the transaction."},"attachment_id":{"type":"integer","description":"The unique identifier of the attachment."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id":{"get":{"operationId":"finance_pocketsmith_get_users_id","summary":"Get user","description":"GET /users/{id}","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-users-id":{"post":{"operationId":"finance_pocketsmith_put_users_id","summary":"Update user","description":"PUT /users/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-accounts":{"get":{"operationId":"finance_pocketsmith_get_users_id_accounts","summary":"List accounts in user","description":"GET /users/{id}/accounts","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-users-id-accounts":{"post":{"operationId":"finance_pocketsmith_post_users_id_accounts","summary":"Create an account in user","description":"POST /users/{id}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/put-users-id-accounts":{"post":{"operationId":"finance_pocketsmith_put_users_id_accounts","summary":"Update the display order of accounts in user","description":"PUT /users/{id}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-attachments":{"get":{"operationId":"finance_pocketsmith_get_users_id_attachments","summary":"Lists attachments in user","description":"GET /users/{id}/attachments","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42},{"name":"unassigned","in":"query","required":false,"description":"If set, returns unassigned attachments, that are available for assigning to a transaction.","schema":{"type":"integer","description":"If set, returns unassigned attachments, that are available for assigning to a transaction."},"example":1}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-users-id-attachments":{"post":{"operationId":"finance_pocketsmith_post_users_id_attachments","summary":"Create attachment in user","description":"POST /users/{id}/attachments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-budget":{"get":{"operationId":"finance_pocketsmith_get_users_id_budget","summary":"List budget for user","description":"GET /users/{id}/budget","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the account.","schema":{"type":"integer","description":"The unique identifier of the account."},"example":42},{"name":"roll_up","in":"query","required":false,"description":"Whether parent categories should have their children rolled up into them. When used, the children will still appear in the collection on…","schema":{"type":"boolean","description":"Whether parent categories should have their children rolled up into them. When used, the children will still appear in the collection on…"},"example":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-budget-summary":{"get":{"operationId":"finance_pocketsmith_get_users_id_budget_summary","summary":"Get budget summary for user","description":"GET /users/{id}/budget_summary","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42},{"name":"period","in":"query","required":true,"description":"The period to analyse in, one of `weeks`, `months` or `years`. Also supported is `event`, although event period analysis is only possible…","schema":{"type":"string","enum":["weeks","months","years","event"],"description":"The period to analyse in, one of `weeks`, `months` or `years`. Also supported is `event`, although event period analysis is only possible…"},"example":"weeks"},{"name":"interval","in":"query","required":true,"description":"The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly.","schema":{"type":"integer","description":"The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly."},"example":2},{"name":"start_date","in":"query","required":true,"description":"The date to start analysing the budget from. This will be bumped out to make full periods as necessary.","schema":{"type":"string","description":"The date to start analysing the budget from. This will be bumped out to make full periods as necessary."},"example":"2025-10-15T13:51:08.358Z"},{"name":"end_date","in":"query","required":true,"description":"The date to stop analysing the budget from. This will be bumped out to make full periods as necessary.","schema":{"type":"string","description":"The date to stop analysing the budget from. This will be bumped out to make full periods as necessary."},"example":"2025-10-15T13:51:08.358Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-categories":{"get":{"operationId":"finance_pocketsmith_get_users_id_categories","summary":"List categories in user","description":"GET /users/{id}/categories","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-users-id-categories":{"post":{"operationId":"finance_pocketsmith_post_users_id_categories","summary":"Create category in user","description":"POST /users/{id}/categories","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-category-rules":{"get":{"operationId":"finance_pocketsmith_get_users_id_category_rules","summary":"List category rules in user","description":"GET /users/{id}/category_rules","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-events":{"get":{"operationId":"finance_pocketsmith_get_users_id_events","summary":"List events in user.","description":"GET /users/{id}/events","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42},{"name":"start_date","in":"query","required":true,"description":"Return the events from and including this date.","schema":{"type":"string","description":"Return the events from and including this date."},"example":"2025-10-15T13:51:08.358Z"},{"name":"end_date","in":"query","required":true,"description":"Return the events until and including this date.","schema":{"type":"string","description":"Return the events until and including this date."},"example":"2025-10-15T13:51:08.358Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/delete-users-id-forecast-cache":{"post":{"operationId":"finance_pocketsmith_delete_users_id_forecast_cache","summary":"Delete forecast cache for user","description":"DELETE /users/{id}/forecast_cache","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-institutions":{"get":{"operationId":"finance_pocketsmith_get_users_id_institutions","summary":"List institutions in user","description":"GET /users/{id}/institutions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user","schema":{"type":"integer","description":"The unique identifier of the user"},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/post-users-id-institutions":{"post":{"operationId":"finance_pocketsmith_post_users_id_institutions","summary":"Create institution in user","description":"POST /users/{id}/institutions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier of the user"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-labels":{"get":{"operationId":"finance_pocketsmith_get_users_id_labels","summary":"List labels in user","description":"GET /users/{id}/labels","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-saved-searches":{"get":{"operationId":"finance_pocketsmith_get_users_id_saved_searches","summary":"List saved searches in user","description":"GET /users/{id}/saved_searches","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-transaction-accounts":{"get":{"operationId":"finance_pocketsmith_get_users_id_transaction_accounts","summary":"List transaction accounts in user","description":"GET /users/{id}/transaction_accounts","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-transactions":{"get":{"operationId":"finance_pocketsmith_get_users_id_transactions","summary":"List transactions in user","description":"GET /users/{id}/transactions","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the account.","schema":{"type":"integer","description":"The unique identifier of the account."},"example":42},{"name":"start_date","in":"query","required":false,"description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…","schema":{"type":"string","description":"Limit to transactions on or after this date. Required if end_date is provided. If not provided, defaults to the furtherest date allowed by…"},"example":"2025-10-15T13:51:08.358Z"},{"name":"end_date","in":"query","required":false,"description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date.","schema":{"type":"string","description":"Limit to transactions on or before this date. Required if start_date is provided. If not provided, defaults to today's date."},"example":"2025-10-15T13:51:08.358Z"},{"name":"updated_since","in":"query","required":false,"description":"Limit to transactions updated since an ISO 8601 timestamp.","schema":{"type":"string","description":"Limit to transactions updated since an ISO 8601 timestamp."},"example":"2025-10-15T13:51:08.358Z"},{"name":"uncategorised","in":"query","required":false,"description":"Limit to uncategorised transactions.","schema":{"type":"integer","description":"Limit to uncategorised transactions."},"example":1},{"name":"type","in":"query","required":false,"description":"Limit to transactions of this type.","schema":{"type":"string","enum":["debit","credit"],"description":"Limit to transactions of this type."},"example":"debit"},{"name":"needs_review","in":"query","required":false,"description":"Limit to transactions that need to be reviewed.","schema":{"type":"integer","description":"Limit to transactions that need to be reviewed."},"example":1},{"name":"search","in":"query","required":false,"description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…","schema":{"type":"string","description":"Limit to transactions matching a keyword search string. The provided string is matched against the transaction amount, account name,…"},"example":"Paypal"},{"name":"page","in":"query","required":false,"description":"Choose a particular page of the results.","schema":{"type":"integer","description":"Choose a particular page of the results."},"example":3}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:pocketsmith/get-users-id-trend-analysis":{"get":{"operationId":"finance_pocketsmith_get_users_id_trend_analysis","summary":"Get trend analysis for user","description":"GET /users/{id}/trend_analysis","tags":["finance"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of the user.","schema":{"type":"integer","description":"The unique identifier of the user."},"example":42},{"name":"period","in":"query","required":true,"description":"The period to analyse in, one of `weeks`, `months` or `years`. Also supported is `event`, although event period analysis is only possible…","schema":{"type":"string","enum":["weeks","months","years","event"],"description":"The period to analyse in, one of `weeks`, `months` or `years`. Also supported is `event`, although event period analysis is only possible…"},"example":"weeks"},{"name":"interval","in":"query","required":true,"description":"The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly.","schema":{"type":"integer","description":"The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly."},"example":true},{"name":"start_date","in":"query","required":true,"description":"The date to start analysing the budget from. This will be bumped out to make full periods as necessary.","schema":{"type":"string","description":"The date to start analysing the budget from. This will be bumped out to make full periods as necessary."},"example":"2025-10-15T13:51:08.358Z"},{"name":"end_date","in":"query","required":true,"description":"The date to stop analysing the budget from. This will be bumped out to make full periods as necessary.","schema":{"type":"string","description":"The date to stop analysing the budget from. This will be bumped out to make full periods as necessary."},"example":"2025-10-15T13:51:08.358Z"},{"name":"categories","in":"query","required":true,"description":"A comma-separated list of category IDs to analyse.","schema":{"type":"string","description":"A comma-separated list of category IDs to analyse."},"example":"42,49"},{"name":"scenarios","in":"query","required":true,"description":"A comma-separated list of scenario IDs to analyse. You're likely going to want to include all a user's scenarios here, unless you have…","schema":{"type":"string","description":"A comma-separated list of scenario IDs to analyse. You're likely going to want to include all a user's scenarios here, unless you have…"},"example":"11,29"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}