logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

First Transaction Date

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
{}

Read

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

A unique integer value identifying this portfolio.

Responses

Response samples

Content type
application/json
{
  • "portfolio": "string",
  • "date_field": "transaction_date"
}

Delete preview

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

A unique integer value identifying this portfolio.

Responses

Response samples

Content type
application/json
{
  • "portfolio": "string",
  • "date_field": "transaction_date"
}

Portfolio Attribute Type

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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Delete preview

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Objects to recalculate

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Recalculate attributes

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

A unique integer value identifying this attribute type.

Request Body schema: application/json
required
task_id
string or null (Task id)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "stats": "string",
  • "stats_file_report": "string"
}

Portfolio Bundle

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
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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 portfolio bundle.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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 portfolio bundle.

Request Body schema: application/json
required
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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 portfolio bundle.

Request Body schema: application/json
required
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

user_code
string or null (User code) <= 255 characters
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

registers
Array of integers unique
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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 portfolio bundle.

Responses

Delete preview

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

A unique integer value identifying this portfolio bundle.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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"
}

Get portfolio registers

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

A unique integer value identifying this portfolio bundle.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "registers": [
    ],
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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"
}

Portfolio Class

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read

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

A unique value identifying this portfolio class.

Responses

Response samples

Content type
application/json
{
  • "id": 32767,
  • "user_code": "string",
  • "name": "string",
  • "description": "string"
}

Portfolio Classifier

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
{}

Read

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

A unique integer value identifying this classifier.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "attribute_type": 0,
  • "level": 0,
  • "parent": 0,
  • "name": "string"
}

Portfolio History

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
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

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
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

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
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Calculate

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
string (Pricing policy)
date
required
string <date> (Date)
calculation_period_date_from
string <date> (Calculation period date from)
segmentation_type
string (Segmentation type)
Default: "business_days_end_of_months"
Enum: "days" "business_days" "business_days_end_of_months"
period_type
string (Period type)
Default: "ytd"
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
string (Cost method)
performance_method
string (Performance method)
Default: "modified_dietz"
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) non-empty
Default: "sp_500"

Responses

Request samples

Content type
application/json
{
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": "string",
  • "date": "2019-08-24",
  • "calculation_period_date_from": "2019-08-24",
  • "segmentation_type": "days",
  • "period_type": "daily",
  • "cost_method": "string",
  • "performance_method": "modified_dietz",
  • "benchmark": "sp_500"
}

Response samples

Content type
application/json
{
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": "string",
  • "date": "2019-08-24",
  • "calculation_period_date_from": "2019-08-24",
  • "segmentation_type": "days",
  • "period_type": "daily",
  • "cost_method": "string",
  • "performance_method": "modified_dietz",
  • "benchmark": "sp_500"
}

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
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

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
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Read

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

A unique integer value identifying this portfolio history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Update

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

A unique integer value identifying this portfolio history.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Partial update

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

A unique integer value identifying this portfolio history.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
portfolio
required
string (Portfolio)
currency
string (Currency)
pricing_policy
required
integer (Pricing policy)
date
string <date> (Date)
date_from
string <date> (Date from)
period_type
string (Period_type)
Enum: "daily" "ytd" "mtd" "qtd" "inception"
cost_method
required
integer (Cost method)
performance_method
string (Performance method)
Enum: "modified_dietz" "time_weighted"
benchmark
string (Benchmark) <= 255 characters
nav
number or null (Nav)

Net Asset Value

gav
number or null (Gav)

Gross Asset Value

cash_flow
number or null (Cash flow)
cash_inflow
number or null (Cash inflow)
cash_outflow
number or null (Cash outflow)
total
number or null (Total)

Total Value of the Portfolio from P&L Report

cumulative_return
number or null (Cumulative return)
annualized_return
number or null (Annualized return)
portfolio_volatility
number or null (Portfolio volatility)
annualized_portfolio_volatility
number or null (Annualized portfolio volatility)
sharpe_ratio
number or null (Sharpe_ratio)
max_annualized_drawdown
number or null (Max_annualized_drawdown)
betta
number or null (Betta)
alpha
number or null (Alpha)
correlation
number or null (Correlation)
weighted_duration
number or null (Weighted_duration)
is_enabled
boolean (Is enabled)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
object (CurrencyView)
object (PortfolioView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Delete

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

A unique integer value identifying this portfolio history.

Responses

Delete preview

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

A unique integer value identifying this portfolio history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio": "string",
  • "currency": "string",
  • "pricing_policy": 0,
  • "date": "2019-08-24",
  • "date_from": "2019-08-24",
  • "period_type": "daily",
  • "cost_method": 0,
  • "performance_method": "modified_dietz",
  • "benchmark": "string",
  • "nav": 0,
  • "gav": 0,
  • "cash_flow": 0,
  • "cash_inflow": 0,
  • "cash_outflow": 0,
  • "total": 0,
  • "cumulative_return": 0,
  • "annualized_return": 0,
  • "portfolio_volatility": 0,
  • "annualized_portfolio_volatility": 0,
  • "sharpe_ratio": 0,
  • "max_annualized_drawdown": 0,
  • "betta": 0,
  • "alpha": 0,
  • "correlation": 0,
  • "weighted_duration": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "is_enabled": true,
  • "error_message": "string",
  • "status": "ok",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string",
  • "currency_object": {
    },
  • "portfolio_object": {
    },
  • "pricing_policy_object": {
    }
}

Portfolio Reconcile Group

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
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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 portfolio reconcile group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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 portfolio reconcile group.

Request Body schema: application/json
required
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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 portfolio reconcile group.

Request Body schema: application/json
required
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

user_code
string or null (User code) <= 255 characters
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

portfolios
required
Array of strings
required
object (Params)
last_calculated_at
string or null <date-time> (Last time calculation was done)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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 portfolio reconcile group.

Responses

Delete preview

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

A unique integer value identifying this portfolio reconcile group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "short_name": "string",
  • "user_code": "string",
  • "public_name": "string",
  • "notes": "string",
  • "portfolios": [
    ],
  • "params": {
    },
  • "last_calculated_at": "2019-08-24T14:15:22Z",
  • "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"
}

Portfolio Reconcile History

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
portfolio_reconcile_group
required
integer (Portfolio reconcile group)
date
string <date> (Date)
verbose_result
string or null (Verbose result)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
file_report
integer or null (File report)
is_enabled
boolean (Is enabled)
report_ttl
integer (Number of days until report expires) [ 0 .. 2147483647 ]
object (PortfolioReconcileGroup)
object (FileReport)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Bulk calculate

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
reconcile_groups
required
Array of strings
dates
required
Array of strings <date> [ items <date > ]

Responses

Request samples

Content type
application/json
{
  • "reconcile_groups": [
    ],
  • "dates": [
    ]
}

Response samples

Content type
application/json
{
  • "reconcile_groups": [
    ],
  • "dates": [
    ]
}

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
portfolio_reconcile_group
required
integer (Portfolio reconcile group)
date
string <date> (Date)
verbose_result
string or null (Verbose result)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
file_report
integer or null (File report)
is_enabled
boolean (Is enabled)
report_ttl
integer (Number of days until report expires) [ 0 .. 2147483647 ]
object (PortfolioReconcileGroup)
object (FileReport)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

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
portfolio_reconcile_group
required
integer (Portfolio reconcile group)
date
string <date> (Date)
verbose_result
string or null (Verbose result)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
file_report
integer or null (File report)
is_enabled
boolean (Is enabled)
report_ttl
integer (Number of days until report expires) [ 0 .. 2147483647 ]
object (PortfolioReconcileGroup)
object (FileReport)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Calculate

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio_reconcile_group
required
string (Portfolio reconcile group)
dates
required
Array of strings <date> [ items <date > ]

Responses

Request samples

Content type
application/json
{
  • "portfolio_reconcile_group": "string",
  • "dates": [
    ]
}

Response samples

Content type
application/json
{
  • "portfolio_reconcile_group": "string",
  • "dates": [
    ]
}

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
portfolio_reconcile_group
required
integer (Portfolio reconcile group)
date
string <date> (Date)
verbose_result
string or null (Verbose result)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
file_report
integer or null (File report)
is_enabled
boolean (Is enabled)
report_ttl
integer (Number of days until report expires) [ 0 .. 2147483647 ]
object (PortfolioReconcileGroup)
object (FileReport)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

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
portfolio_reconcile_group
required
integer (Portfolio reconcile group)
date
string <date> (Date)
verbose_result
string or null (Verbose result)
error_message
string or null (Error_message)

Error message if any

status
string (Status)
Enum: "ok" "error"
file_report
integer or null (File report)
is_enabled
boolean (Is enabled)
report_ttl
integer (Number of days until report expires) [ 0 .. 2147483647 ]
object (PortfolioReconcileGroup)
object (FileReport)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Status

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
{}

Read

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

A unique integer value identifying this portfolio reconcile history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Delete preview

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

A unique integer value identifying this portfolio reconcile history.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "portfolio_reconcile_group": 0,
  • "date": "2019-08-24",
  • "verbose_result": "string",
  • "error_message": "string",
  • "status": "ok",
  • "file_report": 0,
  • "is_enabled": true,
  • "report_ttl": 2147483647,
  • "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",
  • "portfolio_reconcile_group_object": {
    },
  • "file_report_object": {
    }
}

Portfolio Register Attribute Type

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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Delete preview

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Objects to recalculate

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Recalculate attributes

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

A unique integer value identifying this attribute type.

Request Body schema: application/json
required
task_id
string or null (Task id)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "stats": "string",
  • "stats_file_report": "string"
}

Portfolio Register Record

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
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Read

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

A unique integer value identifying this portfolio register record.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Update

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

A unique integer value identifying this portfolio register record.

Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Partial update

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

A unique integer value identifying this portfolio register record.

Request Body schema: application/json
required
portfolio
required
integer (Portfolio)
instrument
required
integer (Instrument)
transaction_class
required
integer (Transaction class)
transaction_code
integer (Transaction code) [ -2147483648 .. 2147483647 ]
transaction_date
string <date> (Transaction date)
cash_amount
number (Cash amount)

Cash amount

cash_currency
required
integer (Cash currency)
fx_rate
number (Fx rate)
cash_amount_valuation_currency
number (Cash amount valuation currency)

Cash amount valuation currency

valuation_currency
required
integer (Valuation currency)
nav_valuation_currency
number (Nav valuation currency)
nav_previous_business_day_valuation_currency
number (Nav previous business day valuation currency)
nav_previous_register_record_day_valuation_currency
number (Nav previous register record day valuation currency)
n_shares_previous_day
number (N shares previous day)
n_shares_added
number (N shares added)
dealing_price_valuation_currency
number (Dealing price valuation currency)

Dealing price valuation currency

rolling_shares_of_the_day
number (Rolling shares of the day)
transaction
required
integer (Transaction)
complex_transaction
required
integer (Complex transaction)
portfolio_register
required
integer (Portfolio register)
share_price_calculation_type
string (Price calculation type) [ 1 .. 255 ] characters
object (CurrencyView)
object (CurrencyView)
object (TransactionClass)
object (PortfolioView)
object (PortfolioRegisterView)
object (InstrumentView)
object (PricingPolicy)

Responses

Request samples

Content type
application/json
{
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Delete

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

A unique integer value identifying this portfolio register record.

Responses

Delete preview

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

A unique integer value identifying this portfolio register record.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "portfolio": 0,
  • "instrument": 0,
  • "transaction_class": 0,
  • "transaction_code": -2147483648,
  • "transaction_date": "2019-08-24",
  • "cash_amount": 0,
  • "cash_currency": 0,
  • "fx_rate": 0,
  • "cash_amount_valuation_currency": 0,
  • "valuation_currency": 0,
  • "nav_valuation_currency": 0,
  • "nav_previous_business_day_valuation_currency": 0,
  • "nav_previous_register_record_day_valuation_currency": 0,
  • "n_shares_previous_day": 0,
  • "n_shares_added": 0,
  • "dealing_price_valuation_currency": 0,
  • "rolling_shares_of_the_day": 0,
  • "transaction": 0,
  • "complex_transaction": 0,
  • "portfolio_register": 0,
  • "share_price_calculation_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "cash_currency_object": {
    },
  • "valuation_currency_object": {
    },
  • "transaction_class_object": {
    },
  • "portfolio_object": {
    },
  • "portfolio_register_object": {
    },
  • "instrument_object": {
    },
  • "valuation_pricing_policy_object": {
    }
}

Portfolio Register

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Calculate price history

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
date_from
string <date> (Date from)
date_to
string <date> (Date to)
portfolios
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "portfolios": [
    ]
}

Response samples

Content type
application/json
{
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "portfolios": [
    ]
}

Calculate records

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
portfolios
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "portfolios": [
    ]
}

Response samples

Content type
application/json
{
  • "portfolios": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Read

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

A unique integer value identifying this portfolio register.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Update

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

A unique integer value identifying this portfolio register.

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Partial update

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

A unique integer value identifying this portfolio register.

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio
required
integer (Portfolio)
object (PortfolioView)
linked_instrument
integer or null (Linked instrument)
object (InstrumentView)
valuation_currency
string (Valuation currency)
object (CurrencyView)
valuation_pricing_policy
required
string (Valuation pricing policy)
object (PricingPolicy)
default_price
number (Default price)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Delete

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

A unique integer value identifying this portfolio register.

Responses

Delete preview

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

A unique integer value identifying this portfolio register.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio": 0,
  • "portfolio_object": {
    },
  • "linked_instrument": 0,
  • "linked_instrument_object": {
    },
  • "valuation_currency": "string",
  • "valuation_currency_object": {
    },
  • "valuation_pricing_policy": "string",
  • "valuation_pricing_policy_object": {
    },
  • "default_price": 0,
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ]
}

Portfolio Type Attribute Type

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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

prefix
string or null (Prefix) <= 255 characters
favorites
string or null (Favorites)
expr
string or null (Expr) <= 4096 characters
Default: "\"\""
can_recalculate
boolean (Can recalculate)
tooltip
string or null (Tooltip)
kind
integer (Kind)
Enum: 1 2
content_type
required
string (Content type)
value_type
integer (Value type)
Enum: 20 10 40 30
order
integer (Order) [ -2147483648 .. 2147483647 ]
is_hidden
boolean (Is hidden)
Default: false
Array of objects or null or null (GenericClassifier)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "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 attribute type.

Responses

Delete preview

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Objects to recalculate

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

A unique integer value identifying this attribute type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "prefix": "string",
  • "favorites": "string",
  • "expr": "\"\"",
  • "can_recalculate": true,
  • "tooltip": "string",
  • "kind": 1,
  • "content_type": "string",
  • "value_type": 20,
  • "order": -2147483648,
  • "is_hidden": false,
  • "classifiers": [
    ],
  • "classifiers_flat": [
    ],
  • "deleted_user_code": "string"
}

Recalculate attributes

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

A unique integer value identifying this attribute type.

Request Body schema: application/json
required
task_id
string or null (Task id)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "task_status": "string",
  • "processed_rows": "string",
  • "total_rows": "string",
  • "stats": "string",
  • "stats_file_report": "string"
}

Portfolio Type

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
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

List attributes

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": [
    ]
}

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
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

List light

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": [
    ]
}

Read

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

A unique integer value identifying this portfolio type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 portfolio type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 portfolio type.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
configuration_code
required
string (Configuration Code) [ 1 .. 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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_class
required
integer (Portfolio class)
object (PortfolioClass)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "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 portfolio type.

Responses

Delete preview

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

A unique integer value identifying this portfolio type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_class": 0,
  • "portfolio_class_object": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "deleted_user_code": "string"
}

Portfolio

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

List attributes

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": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

Get inception date

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": [
    ]
}

List light

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": [
    ]
}

Read

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

A unique integer value identifying this portfolio.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

Update

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

A unique integer value identifying this portfolio.

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

Partial update

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

A unique integer value identifying this portfolio.

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

is_deleted
boolean (Is deleted)

Mark object as deleted. Does not actually delete the object.

is_enabled
boolean (Is enabled)
portfolio_type
integer or null (Portfolio type)
object (PortfolioType)
client
integer (Client)
object (Clients)
is_active
boolean (Is active)
Default: true
actual_at
string or null <date-time> (Actual at)
source_type
string (Source type)
Default: "manual"
Enum: "manual" "external"
source_origin
string (Source origin) non-empty
Default: "manual"
external_id
string or null (External id) non-empty
is_manual_locked
boolean (Is manual locked)
Default: false
is_locked
boolean (Is locked)
Default: true
Array of objects or null or null (GenericAttribute)
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "attributes": [
    ],
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}

Delete

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

A unique integer value identifying this portfolio.

Responses

Delete preview

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

A unique integer value identifying this portfolio.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "is_default": "string",
  • "is_deleted": true,
  • "is_enabled": true,
  • "registers": [
    ],
  • "first_transaction": { },
  • "first_transaction_date": "string",
  • "first_cash_flow_date": "string",
  • "portfolio_type": 0,
  • "portfolio_type_object": {
    },
  • "client": 0,
  • "client_object": {
    },
  • "is_active": true,
  • "actual_at": "2019-08-24T14:15:22Z",
  • "source_type": "manual",
  • "source_origin": "manual",
  • "external_id": "string",
  • "is_manual_locked": false,
  • "is_locked": true,
  • "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",
  • "attributes": [
    ],
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ],
  • "accounts_object": [
    ],
  • "responsibles_object": [
    ],
  • "counterparties_object": [
    ],
  • "transaction_types_object": [
    ]
}