logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

E-mail: admin@finmars.com License: BSD License Terms of Service

Finmars Documentation

Backend Balance Report

Groups

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
calculate_pl
boolean (Calculate pl)
Default: false

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "calculate_pl": false
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "calculate_pl": false,
  • "items": "string"
}

Items

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
calculate_pl
boolean (Calculate pl)
Default: false

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "calculate_pl": false
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "calculate_pl": false,
  • "items": "string"
}

Backend Pl Report

Groups

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
period_type
string or null (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "period_type": "daily"
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": "string",
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": "string",
  • "period_type": "daily"
}

Items

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
period_type
string or null (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "period_type": "daily"
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": "string",
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": "string",
  • "period_type": "daily"
}

Backend Transaction Report

Groups

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
report_instance_id
string or null (Report instance id)
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "cash_date" "date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5"
depth_level
string or null (Depth level)
Enum: "complex_transaction" "base_transaction" "entry"
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
begin_date
string or null <date> (Begin date)
end_date
required
string <date> (End date)
period_type
string (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"
portfolios
Array of strings or null unique
bundle
string or null (Bundle)
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
custom_fields
Array of integers or null unique
custom_fields_to_calculate
string or null (Custom fields to calculate)
Default: ""
complex_transaction_statuses_filter
string or null (Complex transaction statuses filter)
Default: ""
filters
object or null (Filters)
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40

Responses

Request samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "complex_transaction_statuses_filter": "",
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "custom_fields_object": [
    ],
  • "complex_transaction_statuses_filter": "",
  • "portfolios_object": [
    ],
  • "accounts_object": [
    ],
  • "accounts_position_object": [
    ],
  • "accounts_cash_object": [
    ],
  • "strategies1_object": [
    ],
  • "strategies2_object": [
    ],
  • "strategies3_object": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "items": "string",
  • "item_transaction_classes": [
    ],
  • "item_complex_transactions": [
    ],
  • "item_complex_transaction_status": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "item_responsibles": [
    ],
  • "item_counterparties": [
    ],
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Items

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
report_instance_id
string or null (Report instance id)
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "cash_date" "date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5"
depth_level
string or null (Depth level)
Enum: "complex_transaction" "base_transaction" "entry"
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
begin_date
string or null <date> (Begin date)
end_date
required
string <date> (End date)
period_type
string (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"
portfolios
Array of strings or null unique
bundle
string or null (Bundle)
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
custom_fields
Array of integers or null unique
custom_fields_to_calculate
string or null (Custom fields to calculate)
Default: ""
complex_transaction_statuses_filter
string or null (Complex transaction statuses filter)
Default: ""
filters
object or null (Filters)
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40

Responses

Request samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "complex_transaction_statuses_filter": "",
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "custom_fields_object": [
    ],
  • "complex_transaction_statuses_filter": "",
  • "portfolios_object": [
    ],
  • "accounts_object": [
    ],
  • "accounts_position_object": [
    ],
  • "accounts_cash_object": [
    ],
  • "strategies1_object": [
    ],
  • "strategies2_object": [
    ],
  • "strategies3_object": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "items": "string",
  • "item_transaction_classes": [
    ],
  • "item_complex_transactions": [
    ],
  • "item_complex_transaction_status": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "item_responsibles": [
    ],
  • "item_counterparties": [
    ],
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Balance Report Instance

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report instance.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report instance.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report instance.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report instance.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report instance.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Balance Report Light

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "task_status": "string",
  • "save_report": false,
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "items": "string"
}

List attributes

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Balance Report Sql

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
calculate_pl
boolean (Calculate pl)
Default: false

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "calculate_pl": false
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "calculate_pl": false,
  • "items": "string"
}

List attributes

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Balance Report

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
calculate_pl
boolean (Calculate pl)
Default: false

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "calculate_pl": false
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "calculate_pl": false,
  • "items": "string"
}

List attributes

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Custom Field

Custom-field List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Custom-field Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report custom field.

Responses

Custom-field Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this balance report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Custom-field Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report custom field.

Responses

Custom-field Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Custom-field Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction report custom field.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
user_code
string or null (User code) <= 255 characters
expr
string (Expr) <= 4096 characters
Default: "\"\""
value_type
integer (Value type)
Enum: 20 10 40
notes
string (Notes)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Custom-field Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction report custom field.

Responses

Custom-field Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this transaction report custom field.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "expr": "\"\"",
  • "value_type": 20,
  • "notes": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string"
}

Performance Report

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
begin_date
string or null <date> (Begin date)
end_date
string or null <date> (End date)
calculation_type
string or null (Calculation type)
Default: "modified_dietz"
Enum: "time_weighted" "modified_dietz"
period_type
string or null (Period type)
Default: "ytd"
Enum: "daily" "mtd" "qtd" "ytd" "inception"
segmentation_type
string or null (Segmentation type)
Default: "months"
Enum: "days" "months"
adjustment_type
string or null (Adjustment type)
Default: "original"
Enum: "original" "annualized"
registers
Array of strings or null unique
bundle
string or null (Bundle)
report_currency
string or null (Report currency)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "calculation_type": "time_weighted",
  • "period_type": "daily",
  • "segmentation_type": "days",
  • "adjustment_type": "original",
  • "registers": [
    ],
  • "bundle": "string",
  • "report_currency": "string",
  • "report_currency_object": {
    }
}

Response samples

Content type
application/json
{
  • "save_report": false,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "calculation_type": "time_weighted",
  • "period_type": "daily",
  • "segmentation_type": "days",
  • "adjustment_type": "original",
  • "registers": [
    ],
  • "bundle": "string",
  • "report_currency": "string",
  • "report_currency_object": {
    },
  • "error_message": "string",
  • "items": [
    ],
  • "raw_items": { },
  • "execution_log": { },
  • "begin_nav": "string",
  • "end_nav": "string",
  • "grand_return": "string",
  • "grand_cash_flow_weighted": "string",
  • "grand_cash_flow": "string",
  • "grand_cash_inflow": "string",
  • "grand_cash_outflow": "string",
  • "grand_nav": "string",
  • "grand_absolute_pl": "string"
}

Filtered list

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pl Report Instance

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

short_name
string or null (Short name)

Short Name of the object. Used in dropdown menus

public_name
string or null (Public name) <= 255 characters

Used if user does not have permissions to view object

notes
string or null (Notes)

Notes, any useful information about the object

unique_key
required
string (Unique key) [ 1 .. 32 ] characters

Unique Key. Used for getting Report by its Report Settings

settings
required
string (Settings) non-empty

Settings

report_date
required
string <date> (Report date)
pl_first_date
required
string <date> (Pl first date)
report_currency
required
integer (Report currency)
pricing_policy
integer or null (Pricing policy)
cost_method
integer or null (Cost method)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Responses

Data

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this pl report instance.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "unique_key": "string",
  • "settings": "string",
  • "report_date": "2019-08-24",
  • "pl_first_date": "2019-08-24",
  • "report_currency": 0,
  • "pricing_policy": 0,
  • "cost_method": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Pl Report Sql

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
period_type
string or null (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "period_type": "daily"
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": "string",
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": "string",
  • "period_type": "daily"
}

List attributes

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pl Report

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
save_report
boolean (Save report)
Default: false
ignore_cache
boolean (Ignore cache)
Default: false
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
cost_method
required
integer or null (Cost method)
calculation_group
string (Calculation group)
Default: "no_grouping"
Enum: "no_grouping" "portfolio.id" "account.id" "strategy1" "strategy2" "strategy3"

Calculation grouping

portfolio_mode
integer (Portfolio mode)
Default: 1
Enum: 0 1 2

Portfolio consolidation

account_mode
integer (Account mode)
Default: 1
Enum: 0 1 2

Account consolidation

strategy1_mode
integer (Strategy1 mode)
Default: 1
Enum: 0 1 2

Strategy1 consolidation

strategy2_mode
integer (Strategy2 mode)
Default: 1
Enum: 0 1 2

Strategy2 consolidation

strategy3_mode
integer (Strategy3 mode)
Default: 1
Enum: 0 1 2

Strategy3 consolidation

allocation_mode
integer (Allocation mode)
Default: 1
Enum: 0 1 2

Allocation consolidation

only_numbers
boolean (Only numbers)
Default: false
custom_fields_to_calculate
string or null (Custom fields to calculate)
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
custom_fields
Array of integers or null unique
portfolios
Array of strings or null unique
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "date" "cash_date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5" "user_date_6" "user_date_7" "user_date_8" "user_date_9" "user_date_10"
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40
period_type
string or null (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"

Responses

Request samples

Content type
application/json
{
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "period_type": "daily"
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "save_report": false,
  • "ignore_cache": false,
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "cost_method": 0,
  • "calculation_group": "no_grouping",
  • "portfolio_mode": 0,
  • "account_mode": 0,
  • "strategy1_mode": 0,
  • "strategy2_mode": 0,
  • "strategy3_mode": 0,
  • "allocation_mode": 0,
  • "only_numbers": false,
  • "custom_fields_to_calculate": "string",
  • "expression_iterations_count": 1,
  • "custom_fields": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "portfolios": [
    ],
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "date_field": "transaction_date",
  • "custom_fields_object": [
    ],
  • "item_instruments": "string",
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40,
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": "string",
  • "period_type": "daily"
}

List attributes

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Price History Check Sql

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
object (PricingPolicyView)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "report_currency_object": {
    }
}

Response samples

Content type
application/json
{
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "pricing_policy_object": {
    },
  • "report_currency_object": {
    },
  • "items": "string"
}

Price History Check

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
pl_first_date
string or null <date> (Pl first date)

First date for pl report

report_date
string or null <date> (Report date)
Default: "2025-02-20"

Report date or second date for pl report

report_currency
string or null (Report currency)
pricing_policy
required
string (Pricing policy)
object (PricingPolicyView)
object (CurrencyView)

Responses

Request samples

Content type
application/json
{
  • "pl_first_date": "2019-08-24",
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "pricing_policy_object": {
    },
  • "report_currency_object": {
    }
}

Response samples

Content type
application/json
{
  • "pl_first_date": "2019-08-24",
  • "report_type": 1,
  • "report_date": "2025-02-20",
  • "report_currency": "string",
  • "pricing_policy": "string",
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "pricing_policy_object": {
    },
  • "report_currency_object": {
    },
  • "items": "string"
}

Summary

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List portfolios

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction Report Sql

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
report_instance_id
string or null (Report instance id)
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "cash_date" "date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5"
depth_level
string or null (Depth level)
Enum: "complex_transaction" "base_transaction" "entry"
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
begin_date
string or null <date> (Begin date)
end_date
required
string <date> (End date)
period_type
string (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"
portfolios
Array of strings or null unique
bundle
string or null (Bundle)
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
custom_fields
Array of integers or null unique
custom_fields_to_calculate
string or null (Custom fields to calculate)
Default: ""
complex_transaction_statuses_filter
string or null (Complex transaction statuses filter)
Default: ""
filters
object or null (Filters)
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40

Responses

Request samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "complex_transaction_statuses_filter": "",
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "custom_fields_object": [
    ],
  • "complex_transaction_statuses_filter": "",
  • "portfolios_object": [
    ],
  • "accounts_object": [
    ],
  • "accounts_position_object": [
    ],
  • "accounts_cash_object": [
    ],
  • "strategies1_object": [
    ],
  • "strategies2_object": [
    ],
  • "strategies3_object": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "items": "string",
  • "item_transaction_classes": [
    ],
  • "item_complex_transactions": [
    ],
  • "item_complex_transaction_status": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "item_responsibles": [
    ],
  • "item_counterparties": [
    ],
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Transaction Report

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
report_instance_id
string or null (Report instance id)
date_field
string or null (Date field)
Enum: "transaction_date" "accounting_date" "cash_date" "date" "user_date_1" "user_date_2" "user_date_3" "user_date_4" "user_date_5"
depth_level
string or null (Depth level)
Enum: "complex_transaction" "base_transaction" "entry"
expression_iterations_count
integer (Expression iterations count) >= 1
Default: 1
begin_date
string or null <date> (Begin date)
end_date
required
string <date> (End date)
period_type
string (Period type)
Enum: "daily" "mtd" "qtd" "ytd" "inception"
portfolios
Array of strings or null unique
bundle
string or null (Bundle)
accounts
Array of strings or null unique
accounts_position
Array of strings or null unique
accounts_cash
Array of strings or null unique
strategies1
Array of strings or null unique
strategies2
Array of strings or null unique
strategies3
Array of strings or null unique
custom_fields
Array of integers or null unique
custom_fields_to_calculate
string or null (Custom fields to calculate)
Default: ""
complex_transaction_statuses_filter
string or null (Complex transaction statuses filter)
Default: ""
filters
object or null (Filters)
frontend_request_options
object or null (Frontend request options)
count
integer (Count) >= 1
Default: 1
page
integer (Page) >= 1
Default: 1
page_size
integer (Page size) >= 1
Default: 40

Responses

Request samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "complex_transaction_statuses_filter": "",
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}

Response samples

Content type
application/json
{
  • "report_instance_id": "string",
  • "date_field": "transaction_date",
  • "depth_level": "complex_transaction",
  • "expression_iterations_count": 1,
  • "begin_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "period_type": "daily",
  • "portfolios": [
    ],
  • "bundle": "string",
  • "accounts": [
    ],
  • "accounts_position": [
    ],
  • "accounts_cash": [
    ],
  • "strategies1": [
    ],
  • "strategies2": [
    ],
  • "strategies3": [
    ],
  • "custom_fields": [
    ],
  • "custom_fields_to_calculate": "",
  • "custom_fields_object": [
    ],
  • "complex_transaction_statuses_filter": "",
  • "portfolios_object": [
    ],
  • "accounts_object": [
    ],
  • "accounts_position_object": [
    ],
  • "accounts_cash_object": [
    ],
  • "strategies1_object": [
    ],
  • "strategies2_object": [
    ],
  • "strategies3_object": [
    ],
  • "execution_time": 0,
  • "relation_prefetch_time": 0,
  • "serialization_time": 0,
  • "auth_time": 0,
  • "items": "string",
  • "item_transaction_classes": [
    ],
  • "item_complex_transactions": [
    ],
  • "item_complex_transaction_status": [
    ],
  • "item_instruments": [
    ],
  • "item_instrument_types": [
    ],
  • "item_countries": [
    ],
  • "item_currencies": [
    ],
  • "item_portfolios": [
    ],
  • "item_accounts": [
    ],
  • "item_account_types": [
    ],
  • "item_strategies1": [
    ],
  • "item_strategies2": [
    ],
  • "item_strategies3": [
    ],
  • "item_responsibles": [
    ],
  • "item_counterparties": [
    ],
  • "filters": { },
  • "frontend_request_options": { },
  • "count": 1,
  • "page": 1,
  • "page_size": 40
}