Skip to main content
POST
Create a cash flow scenario

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Body

application/json
name
string
required

Display name of the new scenario. Must be non-empty and unique for the organization.

color
enum<string>
default:SCENARIO_COLOR_ORANGE

Color key used to display the scenario. Defaults to SCENARIO_COLOR_ORANGE when omitted. SCENARIO_COLOR_GREY is reserved for the main scenario and cannot be assigned here.

Available options:
SCENARIO_COLOR_ORANGE,
SCENARIO_COLOR_GREEN,
SCENARIO_COLOR_RED,
SCENARIO_COLOR_PURPLE,
SCENARIO_COLOR_CYAN,
SCENARIO_COLOR_YELLOW,
SCENARIO_COLOR_PEACH,
SCENARIO_COLOR_PURPLE_LIGHT,
SCENARIO_COLOR_PINK
parent_id
string

ID of the scenario to derive from. Defaults to the organization's main scenario when omitted.

Response

Returns the created cash flow scenario.

cash_flow_scenario
object
required

A cash flow scenario. Scenarios group per-category monthly targets under a named projection. Every organization has exactly one main scenario (is_main: true), which cannot be deleted. Additional scenarios can be created, updated, and deleted.