Annotate a transaction
Sets a transaction's category, tags, memo, or location — the additive edits the narrow transactions.annotate:write scope covers. Requires writes_enabled and an Idempotency-Key. A connection holding only this scope cannot create, delete, or otherwise edit a transaction.
No expected_version is needed: the server reads the row and uses its current version. A concurrent edit between that read and the write still loses the race and returns 409.
curl -X POST "https://api.403fin.io/v1/transactions/123e4567-e89b-12d3-a456-426614174000/annotate" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example_string"
],
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"clear_location": true
}'
import requests
import json
url = "https://api.403fin.io/v1/transactions/123e4567-e89b-12d3-a456-426614174000/annotate"
headers = {
"Content-Type": "application/json",
"Idempotency-Key": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example_string"
],
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"clear_location": true
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.403fin.io/v1/transactions/123e4567-e89b-12d3-a456-426614174000/annotate", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example_string"
],
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"clear_location": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example_string"
],
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"clear_location": true
}`)
req, err := http.NewRequest("POST", "https://api.403fin.io/v1/transactions/123e4567-e89b-12d3-a456-426614174000/annotate", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Idempotency-Key", "example_string")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.403fin.io/v1/transactions/123e4567-e89b-12d3-a456-426614174000/annotate')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Idempotency-Key'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example_string"
],
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"clear_location": true
}'
response = http.request(request)
puts response.body
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"category_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": {
"amount": "example_string",
"currency": "example_string"
},
"merchant": "example_string",
"display_name": "John Doe",
"description": "example_string",
"date": "2024-12-25",
"posted_at": "2024-12-25T10:00:00Z",
"is_pending": true,
"source": "example_string",
"payment_channel": "example_string",
"transfer_pair_id": "123e4567-e89b-12d3-a456-426614174000",
"recurring_rule_id": "123e4567-e89b-12d3-a456-426614174000",
"external_ref": "example_string",
"tags": [
"example_string"
],
"check_number": "example_string",
"memo": "example_string",
"location": {
"street": "example_string",
"city": "New York",
"state": "example_string",
"postal_code": "example_string",
"country": "USA"
},
"provider_amount": {
"amount": "example_string",
"currency": "example_string"
},
"provider_merchant_name": "John Doe",
"provider_transaction_date": "2024-12-25",
"provider_description": "example_string",
"provider_memo": "example_string",
"version": 42,
"created_at": "2024-12-25T10:00:00Z",
"updated_at": "2024-12-25T10:00:00Z"
},
"pagination": {
"next_cursor": "example_string",
"has_more": true
},
"redacted_fields": [
"example_string"
],
"filtered": true
}
{}
/v1/transactions/{id}/annotateTarget server for requests. Edit to use your own host.
An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
An opaque ff_ credential presented in the X-API-Key header.
The resource UUID.
The media type of the request body
A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours. The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.
An empty string clears the memo.
A purchase location. Redacted as a single unit (transaction.location) — a city plus a postal code answers "where were you" as surely as a street line does, so the components are never hidden separately. On a write it is GROUP-REPLACE: the components sent become the whole stored location and omitted ones are cleared. Use clear_location to remove it entirely.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.
Path Parameters
The resource UUID.
Headers
A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours.
The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.
Body
An empty string clears the memo.
A purchase location. Redacted as a single unit (transaction.location) — a city plus a postal code answers "where were you" as surely as a street line does, so the components are never hidden separately. On a write it is GROUP-REPLACE: the components sent become the whole stored location and omitted ones are cleared. Use clear_location to remove it entirely.
Responses
Cursor pagination state, present on list endpoints.
Field ids stripped from the payload by connection scope.
True when row or aggregate filtering is in effect for this response.