logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

Complex Transaction 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"
}

Complex Transaction

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
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_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
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
visibility_status
integer (Visibility_status)
Enum: 1 2
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
is_deleted
boolean (Is deleted)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "visibility_status": 1,
  • "is_locked": true,
  • "is_canceled": true,
  • "is_deleted": true,
  • "transaction_unique_code": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "first_transaction_accounting_date": "string",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "visibility_status": 1,
  • "is_locked": true,
  • "is_canceled": true,
  • "is_deleted": true,
  • "transaction_unique_code": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

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 complex transaction.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

Update

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

Partial update

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

Delete

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

A unique integer value identifying this complex transaction.

Responses

Delete preview

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

A unique integer value identifying this complex transaction.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

Update properties

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
status
integer (Status)
is_deleted
boolean (Is deleted)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

View

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

A unique integer value identifying this complex transaction.

Responses

Bulk Restore

Bulk-restore Read

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

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
date
string <date> (Date)
status
integer (Status)
code
required
integer (Code) [ -2147483648 .. 2147483647 ]
text
string or null (Text)
transaction_unique_code
string or null (Transaction unique code) <= 255 characters
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
error_code
integer or null (Error code) [ 0 .. 32767 ]
is_deleted
boolean (Is deleted)
user_text_1
string or null (User text 1)
user_text_2
string or null (User text 2)
user_text_3
string or null (User text 3)
user_text_4
string or null (User text 4)
user_text_5
string or null (User text 5)
user_text_6
string or null (User text 6)
user_text_7
string or null (User text 7)
user_text_8
string or null (User text 8)
user_text_9
string or null (User text 9)
user_text_10
string or null (User text 10)
user_text_11
string or null (User text 11)
user_text_12
string or null (User text 12)
user_text_13
string or null (User text 13)
user_text_14
string or null (User text 14)
user_text_15
string or null (User text 15)
user_text_16
string or null (User text 16)
user_text_17
string or null (User text 17)
user_text_18
string or null (User text 18)
user_text_19
string or null (User text 19)
user_text_20
string or null (User text 20)
user_text_21
string or null (User text 21)
user_text_22
string or null (User text 22)
user_text_23
string or null (User text 23)
user_text_24
string or null (User text 24)
user_text_25
string or null (User text 25)
user_text_26
string or null (User text 26)
user_text_27
string or null (User text 27)
user_text_28
string or null (User text 28)
user_text_29
string or null (User text 29)
user_text_30
string or null (User text 30)
user_number_1
number or null (User number 1)
user_number_2
number or null (User number 2)
user_number_3
number or null (User number 3)
user_number_4
number or null (User number 4)
user_number_5
number or null (User number 5)
user_number_6
number or null (User number 6)
user_number_7
number or null (User number 7)
user_number_8
number or null (User number 8)
user_number_9
number or null (User number 9)
user_number_10
number or null (User number 10)
user_number_11
number or null (User number 11)
user_number_12
number or null (User number 12)
user_number_13
number or null (User number 13)
user_number_14
number or null (User number 14)
user_number_15
number or null (User number 15)
user_number_16
number or null (User number 16)
user_number_17
number or null (User number 17)
user_number_18
number or null (User number 18)
user_number_19
number or null (User number 19)
user_number_20
number or null (User number 20)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
user_date_4
string or null <date> (User date 4)
user_date_5
string or null <date> (User date 5)
Array of objects (ReconciliationComplexTransactionField)
execution_log
string or null (Execution log)
required
Array of objects (ComplexTransactionInput)
Array of objects or null or null (GenericAttribute)
object (TransactionTypeView)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "inputs": [
    ],
  • "attributes": [
    ],
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "status": 0,
  • "code": -2147483648,
  • "text": "string",
  • "transaction_type": 0,
  • "transactions": [
    ],
  • "transaction_unique_code": "string",
  • "is_locked": true,
  • "is_canceled": true,
  • "error_code": 32767,
  • "is_deleted": true,
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_text_4": "string",
  • "user_text_5": "string",
  • "user_text_6": "string",
  • "user_text_7": "string",
  • "user_text_8": "string",
  • "user_text_9": "string",
  • "user_text_10": "string",
  • "user_text_11": "string",
  • "user_text_12": "string",
  • "user_text_13": "string",
  • "user_text_14": "string",
  • "user_text_15": "string",
  • "user_text_16": "string",
  • "user_text_17": "string",
  • "user_text_18": "string",
  • "user_text_19": "string",
  • "user_text_20": "string",
  • "user_text_21": "string",
  • "user_text_22": "string",
  • "user_text_23": "string",
  • "user_text_24": "string",
  • "user_text_25": "string",
  • "user_text_26": "string",
  • "user_text_27": "string",
  • "user_text_28": "string",
  • "user_text_29": "string",
  • "user_text_30": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_number_4": 0,
  • "user_number_5": 0,
  • "user_number_6": 0,
  • "user_number_7": 0,
  • "user_number_8": 0,
  • "user_number_9": 0,
  • "user_number_10": 0,
  • "user_number_11": 0,
  • "user_number_12": 0,
  • "user_number_13": 0,
  • "user_number_14": 0,
  • "user_number_15": 0,
  • "user_number_16": 0,
  • "user_number_17": 0,
  • "user_number_18": 0,
  • "user_number_19": 0,
  • "user_number_20": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "user_date_4": "2019-08-24",
  • "user_date_5": "2019-08-24",
  • "recon_fields": [
    ],
  • "execution_log": "string",
  • "source": { },
  • "inputs": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "attributes": [
    ],
  • "transaction_type_object": {
    },
  • "transactions_object": [
    ]
}

Bulk Update Properties

Bulk-update-properties Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
status
integer (Status)
is_deleted
boolean (Is deleted)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

Bulk-update-properties Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
is_locked
boolean (Is locked)
is_canceled
boolean (Is canceled)
status
integer (Status)
is_deleted
boolean (Is deleted)
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "is_locked": true,
  • "is_canceled": true,
  • "status": 0,
  • "is_deleted": true,
  • "attributes": [
    ]
}

Rebook Pending

Rebook-pending Read

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

A unique integer value identifying this complex transaction.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Rebook-pending Update

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
complex_transaction_status
integer or null (Complex transaction status)
Default: 1
Enum: 1 2 3
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null
object or null (TransactionTypeComplexTransaction)
object (TransactionType)

Responses

Request samples

Content type
application/json
{
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Rebook

Rebook Read

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

A unique integer value identifying this complex transaction.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Rebook Update

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
complex_transaction_status
integer or null (Complex transaction status)
Default: 1
Enum: 1 2 3
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null
object or null (TransactionTypeComplexTransaction)
object (TransactionType)

Responses

Request samples

Content type
application/json
{
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Recalculate

Recalculate Read

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

A unique integer value identifying this complex transaction.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": "string"
}

Recalculate Update

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

A unique integer value identifying this complex transaction.

Request Body schema: application/json
required
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "process_mode": "book",
  • "recalculate_inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": "string"
}

Event 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 event class.

Responses

Response samples

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

Notification 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 notification class.

Responses

Response samples

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

Recalculate Permission Complex Transaction

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
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",
  • "content_type": "string"
}

Recalculate Permission Transaction

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
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",
  • "content_type": "string"
}

Transaction 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"
}

Transaction 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 transaction class.

Responses

Response samples

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

Transaction Classifie

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

Transaction 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"
}

Transaction Type 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
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)

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
}

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,
  • "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

is_deleted
boolean (Is deleted)

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

is_enabled
boolean (Is enabled)

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
}

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,
  • "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)

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
}

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,
  • "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)

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
}

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,
  • "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)

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
}

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,
  • "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 transaction type group.

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,
  • "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 transaction type group.

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)

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
}

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,
  • "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 transaction type group.

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)

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
}

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,
  • "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 transaction type 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 transaction type group.

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,
  • "deleted_user_code": "string"
}

Transaction 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
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_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
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

List light with inputs

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 transaction type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

Update

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

Partial update

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
group
string (Group)
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

date_expr
string or null (Date expr) <= 4096 characters
Default: "now()"
display_expr
string or null (Display expr) <= 4096 characters
Default: ""
visibility_status
integer (Visibility status)
Default: 1
Enum: 1 2
type
integer (Type)
Default: 1
Enum: 1 2
transaction_unique_code_expr
string or null (Transaction unique code expr) <= 4096 characters
Default: ""
transaction_unique_code_options
integer (Transaction unique code options)
Enum: 1 2 3 4
user_text_1
string or null (User text 1) <= 4096 characters
Default: ""
user_text_2
string or null (User text 2) <= 4096 characters
Default: ""
user_text_3
string or null (User text 3) <= 4096 characters
Default: ""
user_text_4
string or null (User text 4) <= 4096 characters
Default: ""
user_text_5
string or null (User text 5) <= 4096 characters
Default: ""
user_text_6
string or null (User text 6) <= 4096 characters
Default: ""
user_text_7
string or null (User text 7) <= 4096 characters
Default: ""
user_text_8
string or null (User text 8) <= 4096 characters
Default: ""
user_text_9
string or null (User text 9) <= 4096 characters
Default: ""
user_text_10
string or null (User text 10) <= 4096 characters
Default: ""
user_text_11
string or null (User text 11) <= 4096 characters
Default: ""
user_text_12
string or null (User text 12) <= 4096 characters
Default: ""
user_text_13
string or null (User text 13) <= 4096 characters
Default: ""
user_text_14
string or null (User text 14) <= 4096 characters
Default: ""
user_text_15
string or null (User text 15) <= 4096 characters
Default: ""
user_text_16
string or null (User text 16) <= 4096 characters
Default: ""
user_text_17
string or null (User text 17) <= 4096 characters
Default: ""
user_text_18
string or null (User text 18) <= 4096 characters
Default: ""
user_text_19
string or null (User text 19) <= 4096 characters
Default: ""
user_text_20
string or null (User text 20) <= 4096 characters
Default: ""
user_text_21
string or null (User text 21) <= 4096 characters
Default: ""
user_text_22
string or null (User text 22) <= 4096 characters
Default: ""
user_text_23
string or null (User text 23) <= 4096 characters
Default: ""
user_text_24
string or null (User text 24) <= 4096 characters
Default: ""
user_text_25
string or null (User text 25) <= 4096 characters
Default: ""
user_text_26
string or null (User text 26) <= 4096 characters
Default: ""
user_text_27
string or null (User text 27) <= 4096 characters
Default: ""
user_text_28
string or null (User text 28) <= 4096 characters
Default: ""
user_text_29
string or null (User text 29) <= 4096 characters
Default: ""
user_text_30
string or null (User text 30) <= 4096 characters
Default: ""
user_number_1
string or null (User number 1) <= 4096 characters
Default: ""
user_number_2
string or null (User number 2) <= 4096 characters
Default: ""
user_number_3
string or null (User number 3) <= 4096 characters
Default: ""
user_number_4
string or null (User number 4) <= 4096 characters
Default: ""
user_number_5
string or null (User number 5) <= 4096 characters
Default: ""
user_number_6
string or null (User number 6) <= 4096 characters
Default: ""
user_number_7
string or null (User number 7) <= 4096 characters
Default: ""
user_number_8
string or null (User number 8) <= 4096 characters
Default: ""
user_number_9
string or null (User number 9) <= 4096 characters
Default: ""
user_number_10
string or null (User number 10) <= 4096 characters
Default: ""
user_number_11
string or null (User number 11) <= 4096 characters
Default: ""
user_number_12
string or null (User number 12) <= 4096 characters
Default: ""
user_number_13
string or null (User number 13) <= 4096 characters
Default: ""
user_number_14
string or null (User number 14) <= 4096 characters
Default: ""
user_number_15
string or null (User number 15) <= 4096 characters
Default: ""
user_number_16
string or null (User number 16) <= 4096 characters
Default: ""
user_number_17
string or null (User number 17) <= 4096 characters
Default: ""
user_number_18
string or null (User number 18) <= 4096 characters
Default: ""
user_number_19
string or null (User number 19) <= 4096 characters
Default: ""
user_number_20
string or null (User number 20) <= 4096 characters
Default: ""
user_date_1
string or null (User date 1) <= 4096 characters
Default: ""
user_date_2
string or null (User date 2) <= 4096 characters
Default: ""
user_date_3
string or null (User date 3) <= 4096 characters
Default: ""
user_date_4
string or null (User date 4) <= 4096 characters
Default: ""
user_date_5
string or null (User date 5) <= 4096 characters
Default: ""
is_valid_for_all_portfolios
boolean (Is valid for all portfolios)
is_valid_for_all_instruments
boolean (Is valid for all instruments)
is_deleted
boolean (Is deleted)

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

book_transaction_layout
object or null (Book transaction layout)
instrument_types
Array of strings or null unique
portfolios
Array of strings or null unique
Array of objects (TransactionTypeInput)
Array of objects (TransactionTypeAction)
Array of objects (TransactionTypeReconField)
Array of objects (TransactionTypeContextParameter)
context_parameters_notes
string or null (Context parameters notes)
is_enabled
boolean (Is enabled)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
Array of objects or null or null (GenericAttribute)

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

Delete

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

A unique integer value identifying this transaction 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 transaction type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "group": "string",
  • "user_code": "string",
  • "name": "string",
  • "short_name": "string",
  • "public_name": "string",
  • "notes": "string",
  • "date_expr": "now()",
  • "display_expr": "",
  • "visibility_status": 1,
  • "type": 1,
  • "transaction_unique_code_expr": "",
  • "transaction_unique_code_options": 1,
  • "user_text_1": "",
  • "user_text_2": "",
  • "user_text_3": "",
  • "user_text_4": "",
  • "user_text_5": "",
  • "user_text_6": "",
  • "user_text_7": "",
  • "user_text_8": "",
  • "user_text_9": "",
  • "user_text_10": "",
  • "user_text_11": "",
  • "user_text_12": "",
  • "user_text_13": "",
  • "user_text_14": "",
  • "user_text_15": "",
  • "user_text_16": "",
  • "user_text_17": "",
  • "user_text_18": "",
  • "user_text_19": "",
  • "user_text_20": "",
  • "user_text_21": "",
  • "user_text_22": "",
  • "user_text_23": "",
  • "user_text_24": "",
  • "user_text_25": "",
  • "user_text_26": "",
  • "user_text_27": "",
  • "user_text_28": "",
  • "user_text_29": "",
  • "user_text_30": "",
  • "user_number_1": "",
  • "user_number_2": "",
  • "user_number_3": "",
  • "user_number_4": "",
  • "user_number_5": "",
  • "user_number_6": "",
  • "user_number_7": "",
  • "user_number_8": "",
  • "user_number_9": "",
  • "user_number_10": "",
  • "user_number_11": "",
  • "user_number_12": "",
  • "user_number_13": "",
  • "user_number_14": "",
  • "user_number_15": "",
  • "user_number_16": "",
  • "user_number_17": "",
  • "user_number_18": "",
  • "user_number_19": "",
  • "user_number_20": "",
  • "user_date_1": "",
  • "user_date_2": "",
  • "user_date_3": "",
  • "user_date_4": "",
  • "user_date_5": "",
  • "is_valid_for_all_portfolios": true,
  • "is_valid_for_all_instruments": true,
  • "is_deleted": true,
  • "book_transaction_layout": { },
  • "instrument_types": [
    ],
  • "portfolios": [
    ],
  • "inputs": [
    ],
  • "actions": [
    ],
  • "recon_fields": [
    ],
  • "context_parameters": [
    ],
  • "context_parameters_notes": "string",
  • "is_enabled": true,
  • "configuration_code": "string",
  • "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",
  • "instrument_types_object": [
    ],
  • "portfolios_object": [
    ]
}

Recalculate user fields

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
task_id
string or null (Task id)
transaction_type_id
integer or null (Transaction type id)
key
string or null (Key)

Responses

Request samples

Content type
application/json
{
  • "task_id": "string",
  • "transaction_type_id": 0,
  • "key": "string"
}

Response samples

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

Recalculate

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "process_mode": "book",
  • "recalculate_inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": "string"
}

Book Pending

Book-pending Read

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

A unique integer value identifying this transaction type.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Book-pending Update

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
complex_transaction_status
integer or null (Complex transaction status)
Default: 1
Enum: 1 2 3
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null
object or null (TransactionTypeComplexTransaction)
object (TransactionType)

Responses

Request samples

Content type
application/json
{
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Book

Book Read

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

A unique integer value identifying this transaction type.

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Book Update

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

A unique integer value identifying this transaction type.

Request Body schema: application/json
required
complex_transaction_status
integer or null (Complex transaction status)
Default: 1
Enum: 1 2 3
process_mode
string or null (Process mode)
Default: "book"
Enum: "book" "recalculate" "rebook"
recalculate_inputs
Array of strings or null
object or null (TransactionTypeComplexTransaction)
object (TransactionType)

Responses

Request samples

Content type
application/json
{
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_type": 0,
  • "complex_transaction_status": 1,
  • "process_mode": "book",
  • "recalculate_inputs": [
    ],
  • "has_errors": true,
  • "value_errors": "string",
  • "instruments_errors": "string",
  • "complex_transaction_errors": "string",
  • "transactions_errors": "string",
  • "general_errors": "string",
  • "instruments": [
    ],
  • "complex_transaction": {
    },
  • "transaction_type_object": {
    },
  • "book_transaction_layout": "string"
}

Transaction

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
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_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
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Read

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

A unique integer value identifying this transaction.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Update

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

A unique integer value identifying this transaction.

Request Body schema: application/json
required
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Partial update

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

A unique integer value identifying this transaction.

Request Body schema: application/json
required
transaction_code
required
integer (Transaction code) [ -2147483648 .. 2147483647 ]

More Human Readable ID, like Complex Transaction has 100, then Transaction will have 101

transaction_class
required
integer (Transaction class)

Important entity, depending on class will be applied different method to calculate report (e.g. Buy, Sell, Transfer)

instrument
string or null (Instrument)
transaction_currency
string or null (Transaction currency)
position_size_with_sign
number (Position size with sign)
settlement_currency
string (Settlement currency)
cash_consideration
number (Cash consideration)
principal_with_sign
number (Principal with sign)
carry_with_sign
number (Carry with sign)
overheads_with_sign
number (Overheads with sign)
reference_fx_rate
number (Reference fx-rate)

FX rate to convert from Settlement ccy to Instrument Ccy on Accounting Date (trade date)

accounting_date
string <date> (Accounting date)
cash_date
string <date> (Cash date)
portfolio
string (Portfolio)
account_cash
string (Account cash)
account_position
string (Account position)
account_interim
string (Account interim)
strategy1_position
string (Strategy1 position)
Default: 1
strategy1_cash
string (Strategy1 cash)
Default: 1
strategy2_position
string (Strategy2 position)
Default: 1
strategy2_cash
string (Strategy2 cash)
Default: 1
strategy3_position
string (Strategy3 position)
Default: 1
strategy3_cash
string (Strategy3 cash)
Default: 1
responsible
string (Responsible)
Default: 1
counterparty
string (Counterparty)
Default: 1
linked_instrument
string (Linked instrument)
allocation_balance
string (Allocation balance)
allocation_pl
string (Allocation pl)
is_canceled
boolean (Is canceled)

Transaction will be filtered out from report calculation

is_deleted
boolean (Is deleted)
error_code
integer or null (Error code) [ 0 .. 32767 ]
factor
number (Factor)

Multiplier (for calculations on the form)

trade_price
number (Trade price)

Price (for calculations on the form)

position_amount
number (Position amount)

Absolute value of Position with Sign (for calculations on the form)

principal_amount
number (Principal amount)

Absolute value of Principal with Sign (for calculations on the form)

carry_amount
number (Carry amount)

Absolute value of Carry with Sign (for calculations on the form)

overheads
number (Overheads)

Absolute value of overheads (for calculations on the form)

ytm_at_cost
number (YTM at cost)

YTM at cost

notes
string or null (Notes)
user_text_1
string or null (User_text_1)
user_text_2
string or null (User_text_2)
user_text_3
string or null (User_text_3)
user_number_1
number or null (User_number_1)
user_number_2
number or null (User_number_2)
user_number_3
number or null (User_number_3)
user_date_1
string or null <date> (User date 1)
user_date_2
string or null <date> (User date 2)
user_date_3
string or null <date> (User date 3)
object (TransactionClass)
object (InstrumentView)
object (CurrencyView)
object (CurrencyView)
object (PortfolioView)
object (AccountView)
object (AccountView)
object (AccountView)
object (Strategy1View)
object (Strategy1View)
object (Strategy2View)
object (Strategy2View)
object (Strategy3View)
object (Strategy3View)
object (ResponsibleView)
object (CounterpartyView)
object (InstrumentView)
object (InstrumentView)
object (InstrumentView)

Responses

Request samples

Content type
application/json
{
  • "transaction_code": -2147483648,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}

Delete

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

A unique integer value identifying this transaction.

Responses

Delete preview

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

A unique integer value identifying this transaction.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "transaction_code": -2147483648,
  • "complex_transaction": 0,
  • "complex_transaction_order": 0,
  • "transaction_class": 0,
  • "instrument": "string",
  • "transaction_currency": "string",
  • "position_size_with_sign": 0,
  • "settlement_currency": "string",
  • "cash_consideration": 0,
  • "principal_with_sign": 0,
  • "carry_with_sign": 0,
  • "overheads_with_sign": 0,
  • "reference_fx_rate": 0,
  • "accounting_date": "2019-08-24",
  • "cash_date": "2019-08-24",
  • "transaction_date": "2019-08-24",
  • "portfolio": "string",
  • "account_cash": "string",
  • "account_position": "string",
  • "account_interim": "string",
  • "strategy1_position": 1,
  • "strategy1_cash": 1,
  • "strategy2_position": 1,
  • "strategy2_cash": 1,
  • "strategy3_position": 1,
  • "strategy3_cash": 1,
  • "responsible": 1,
  • "counterparty": 1,
  • "linked_instrument": "string",
  • "allocation_balance": "string",
  • "allocation_pl": "string",
  • "is_canceled": true,
  • "is_deleted": true,
  • "error_code": 32767,
  • "factor": 0,
  • "trade_price": 0,
  • "position_amount": 0,
  • "principal_amount": 0,
  • "carry_amount": 0,
  • "overheads": 0,
  • "ytm_at_cost": 0,
  • "notes": "string",
  • "user_text_1": "string",
  • "user_text_2": "string",
  • "user_text_3": "string",
  • "user_number_1": 0,
  • "user_number_2": 0,
  • "user_number_3": 0,
  • "user_date_1": "2019-08-24",
  • "user_date_2": "2019-08-24",
  • "user_date_3": "2019-08-24",
  • "transaction_class_object": {
    },
  • "instrument_object": {
    },
  • "transaction_currency_object": {
    },
  • "settlement_currency_object": {
    },
  • "portfolio_object": {
    },
  • "account_position_object": {
    },
  • "account_cash_object": {
    },
  • "account_interim_object": {
    },
  • "strategy1_position_object": {
    },
  • "strategy1_cash_object": {
    },
  • "strategy2_position_object": {
    },
  • "strategy2_cash_object": {
    },
  • "strategy3_position_object": {
    },
  • "strategy3_cash_object": {
    },
  • "responsible_object": {
    },
  • "counterparty_object": {
    },
  • "linked_instrument_object": {
    },
  • "allocation_balance_object": {
    },
  • "allocation_pl_object": {
    }
}