Switch the active budget method
Switches the active budget to a different method. This ARCHIVES the current budget and CREATES a new one, so confirm must be literal true (else 400 validation). Requires the budgets:write scope, writes_enabled, and an Idempotency-Key (a double-fired switch would create two budgets). A SHARED budget cannot be switched here — it returns 409 (partner-approval-required); that approval flow lives only in the app.
curl -X POST "https://api.403fin.io/v1/budgets/method-switch" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"method": "fifty_thirty_twenty",
"confirm": true
}'
import requests
import json
url = "https://api.403fin.io/v1/budgets/method-switch"
headers = {
"Content-Type": "application/json",
"Idempotency-Key": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"method": "fifty_thirty_twenty",
"confirm": true
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.403fin.io/v1/budgets/method-switch", {
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({
"method": "fifty_thirty_twenty",
"confirm": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"method": "fifty_thirty_twenty",
"confirm": true
}`)
req, err := http.NewRequest("POST", "https://api.403fin.io/v1/budgets/method-switch", 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/budgets/method-switch')
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 = '{
"method": "fifty_thirty_twenty",
"confirm": true
}'
response = http.request(request)
puts response.body
{
"data": {
"new_budget_id": "123e4567-e89b-12d3-a456-426614174000",
"previous_budget_archived": true
},
"pagination": {
"next_cursor": "example_string",
"has_more": true
},
"redacted_fields": [
"example_string"
],
"filtered": true
}
{}
/v1/budgets/method-switch
Target 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 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.
The budget method to switch to.
Must be true — the switch archives the current budget and creates a new one.
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.
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
The budget method to switch to.
fifty_thirty_twentypay_yourself_firstzero_basedenvelopekakeibofirevalues_basedcustomMust be true — the switch archives the current budget and creates a new one.
Responses
The result of a budget method switch.
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.