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>"
}
'import requests
url = "https://breadbox.example.com/api/v1/transactions/{id}/category"
payload = { "category_id": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({category_id: '<string>'})
};
fetch('https://breadbox.example.com/api/v1/transactions/{id}/category', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://breadbox.example.com/api/v1/transactions/{id}/category",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'category_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://breadbox.example.com/api/v1/transactions/{id}/category"
payload := strings.NewReader("{\n \"category_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://breadbox.example.com/api/v1/transactions/{id}/category")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://breadbox.example.com/api/v1/transactions/{id}/category")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"counterparty_short_id": "<string>",
"counterparty_name": "<string>",
"counterparty_logo_url": "<string>",
"category_id": "<string>",
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"metadata": {},
"flagged_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Set transaction category
Sets category_id (last-writer-wins; no provenance). Requires full_access scope.
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>"
}
'import requests
url = "https://breadbox.example.com/api/v1/transactions/{id}/category"
payload = { "category_id": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({category_id: '<string>'})
};
fetch('https://breadbox.example.com/api/v1/transactions/{id}/category', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://breadbox.example.com/api/v1/transactions/{id}/category",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'category_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://breadbox.example.com/api/v1/transactions/{id}/category"
payload := strings.NewReader("{\n \"category_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://breadbox.example.com/api/v1/transactions/{id}/category")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://breadbox.example.com/api/v1/transactions/{id}/category")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"counterparty_short_id": "<string>",
"counterparty_name": "<string>",
"counterparty_logo_url": "<string>",
"category_id": "<string>",
"pending": true,
"deleted_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"metadata": {},
"flagged_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}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
Category UUID or short_id.
Response
Updated transaction.
Decimal as string. Positive = money out, negative = money in.
short_id of the assigned counterparty (the other side of the transaction), null when unassigned.
Preferred display name when a counterparty is assigned; falls back to merchant_name then name.
Counterparty logo URL; null until enrichment populates it.
Tag slug.
Free-form JSONB enrichment store. Always an object (empty {} when unset).
When the transaction was flagged for human attention; null when not flagged. The reason lives in a comment annotation.