Skip to content

docs: correct API limitations for payee and category creation #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephendolan merged 1 commit into from
Sep 29, 2026
Merged

docs: correct API limitations for payee and category creation #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,9 @@ All API calls go through `YnabClient.withErrorHandling()` which catches errors a

## API Limitations

YNAB API does not support:
- Creating categories or category groups
- Creating payees
- Creating or updating accounts (beyond initial creation)
YNAB API does not support updating accounts. That must be done through YNAB's web/mobile apps.

These operations must be done through YNAB's web/mobile apps.
The API does support creating payees, categories, category groups, and accounts (see the `create*` methods in the `ynab` SDK's `PayeesApi`, `CategoriesApi`, and `AccountsApi`). Before documenting an API limitation, confirm it against the SDK in `node_modules/ynab/dist/apis/` rather than prior docs.

## Testing

Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,13 @@ All commands return JSON. Use `--compact` for minified output.

## API Limitations

The YNAB API does not support creating categories, category groups, or payees. Use the web or mobile app for these.
The YNAB API does not support updating accounts. Use the web or mobile app for this.

The API supports creating payees, categories, and category groups. Use raw API access for these:

```bash
ynab api POST /plans/{plan_id}/payees --data '{"payee": {"name": "Coffee Shop"}}'
```

Rate limit: 200 requests/hour per token. If exceeded, wait 5-10 minutes.

Expand Down
Loading