Set transaction category
curl --request PATCH \
--url https://breadbox.example.com/api/v1/transactions/{id}/category \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"category_id": "<string>"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"account_id": "<string>",
"connection_id": "<string>",
"attributed_user_id": "<string>",
"date": "2023-12-25",
"authorized_date": "2023-12-25",
"amount": "<string>",
"iso_currency_code": "<string>",
"name": "<string>",
"merchant_name": "<string>",
"category_id": "<string>",
"category_override": true,
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Transactions
Set transaction category
Sets category_id and category_override = true. Requires full_access scope.
PATCH
/
api
/
v1
/
transactions
/
{id}
/
category
Set transaction category
curl --request PATCH \
--url https://breadbox.example.com/api/v1/transactions/{id}/category \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"category_id": "<string>"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"short_id": "<string>",
"account_id": "<string>",
"connection_id": "<string>",
"attributed_user_id": "<string>",
"date": "2023-12-25",
"authorized_date": "2023-12-25",
"amount": "<string>",
"iso_currency_code": "<string>",
"name": "<string>",
"merchant_name": "<string>",
"category_id": "<string>",
"category_override": true,
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Path Parameters
UUID or 8-char short_id.
Body
application/json
Category UUID or short_id.
Response
Updated transaction.
Decimal as string. Positive = money out, negative = money in.
Tag slug.
⌘I