logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

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

Finmars Documentation

Data Procedure Instance

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Read

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

A unique integer value identifying this request data file procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Update

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

A unique integer value identifying this request data file procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Partial update

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

A unique integer value identifying this request data file procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
request_data
object or null (Request data)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
linked_import_task
integer or null (Linked import task)
response_data
string or null (Response data)
procedure
required
integer (Procedure)
object (RequestDataFileProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Delete

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

A unique integer value identifying this request data file procedure instance.

Responses

Delete preview

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

A unique integer value identifying this request data file procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "request_data": { },
  • "status": "I",
  • "error_code": 32767,
  • "error_message": "string",
  • "linked_import_task": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "response_data": "string",
  • "procedure": 0,
  • "procedure_object": {
    }
}

Data Procedure

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Execute

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Read

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

A unique integer value identifying this request data file procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Update

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Partial update

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Delete

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

A unique integer value identifying this request data file procedure.

Responses

Delete preview

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

A unique integer value identifying this request data file procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Run procedure

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Expression Procedure

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

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

A unique integer value identifying this expression procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

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

A unique integer value identifying this expression procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

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

A unique integer value identifying this expression procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

data
object or null (Data)
Array of objects or null or null (ExpressionProcedureContextVariable)
code
string or null (Code)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

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

A unique integer value identifying this expression procedure.

Responses

Delete preview

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

A unique integer value identifying this expression procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "data": { },
  • "context_variables": [
    ],
  • "code": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Run procedure

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

A unique integer value identifying this expression procedure.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Pricing Parent Procedure Instance

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Read

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

A unique integer value identifying this pricing parent procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Update

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

A unique integer value identifying this pricing parent procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Partial update

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

A unique integer value identifying this pricing parent procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
procedure
required
integer (Procedure)
object (PricingProcedure)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "procedure": 0,
  • "procedure_object": {
    }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Delete

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

A unique integer value identifying this pricing parent procedure instance.

Responses

Delete preview

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

A unique integer value identifying this pricing parent procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "procedures": [
    ]
}

Pricing Procedure Instance

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Read

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

A unique integer value identifying this pricing procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Update

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

A unique integer value identifying this pricing procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Partial update

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

A unique integer value identifying this pricing procedure instance.

Request Body schema: application/json
required
master_user
required
integer (Master user)
parent_procedure_instance
integer or null (Parent pricing procedure)
status
string (Status)
Enum: "I" "P" "D" "E" "C"
procedure
required
integer (Procedure)
object (PricingProcedure)
provider_verbose
string or null (Provider verbose) <= 255 characters
action_verbose
string or null (Action verbose) <= 255 characters
successful_prices_count
integer (Successful prices count) [ -2147483648 .. 2147483647 ]
error_prices_count
integer (Error prices count) [ -2147483648 .. 2147483647 ]
error_code
integer or null (Error code) [ 0 .. 32767 ]
error_message
string or null (Error message)
request_data
object or null (Request data)
response_data
object or null (Response data)

Responses

Request samples

Content type
application/json
{
  • "master_user": 0,
  • "parent_procedure_instance": 0,
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Delete

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

A unique integer value identifying this pricing procedure instance.

Responses

Delete preview

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

A unique integer value identifying this pricing procedure instance.

Responses

Response samples

Content type
application/json
{
  • "master_user": 0,
  • "id": 0,
  • "parent_procedure_instance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "status": "I",
  • "procedure": 0,
  • "procedure_object": {
    },
  • "provider_verbose": "string",
  • "action_verbose": "string",
  • "successful_prices_count": -2147483648,
  • "error_prices_count": -2147483648,
  • "error_code": 32767,
  • "error_message": "string",
  • "request_data": { },
  • "response_data": { }
}

Pricing Procedure

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Read

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

A unique integer value identifying this pricing procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Update

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

A unique integer value identifying this pricing procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Partial update

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

A unique integer value identifying this pricing procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

notes
string or null (Notes)

Notes, any useful information about the object

notes_for_users
string (Notes for user)
user_code
string or null (User code) <= 255 characters
type
integer (Type)
Default: 1
Enum: 1 2 3
price_date_from
string or null <date> (Price date from)
price_date_to
string or null <date> (Price date to)
price_date_from_expr
string or null (Price date from expr) <= 4096 characters
Default: ""
price_date_to_expr
string or null (Price date to expr) <= 4096 characters
Default: ""
price_fill_days
integer (Price fill days) [ 0 .. 32767 ]
price_get_principal_prices
boolean (Price get principal prices)
price_get_accrued_prices
boolean (Price get accrued prices)
price_get_fx_rates
boolean (Price get fx rates)
price_overwrite_principal_prices
boolean (Price overwrite principal prices)
price_overwrite_accrued_prices
boolean (Price overwrite accrued prices)
price_overwrite_fx_rates
boolean (Price overwrite fx rates)
instrument_filters
string (Instrument filters)
currency_filters
string (Currency filters)
pricing_policy_filters
string (Pricing policy filters)
portfolio_filters
string (Portfolio filters)
instrument_type_filters
string (Instrument type filters)
instrument_pricing_scheme_filters
string (Instrument pricing scheme filters)
instrument_pricing_condition_filters
string (Instrument pricing condition filters)
currency_pricing_scheme_filters
string (Currency pricing scheme filters)
currency_pricing_condition_filters
string (Currency pricing condition filters)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Delete

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

A unique integer value identifying this pricing procedure.

Responses

Delete preview

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

A unique integer value identifying this pricing procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "notes": "string",
  • "notes_for_users": "string",
  • "user_code": "string",
  • "type": 1,
  • "price_date_from": "2019-08-24",
  • "price_date_to": "2019-08-24",
  • "price_date_from_expr": "",
  • "price_date_to_expr": "",
  • "price_fill_days": 32767,
  • "price_get_principal_prices": true,
  • "price_get_accrued_prices": true,
  • "price_get_fx_rates": true,
  • "price_overwrite_principal_prices": true,
  • "price_overwrite_accrued_prices": true,
  • "price_overwrite_fx_rates": true,
  • "instrument_filters": "string",
  • "currency_filters": "string",
  • "pricing_policy_filters": "string",
  • "portfolio_filters": "string",
  • "instrument_type_filters": "string",
  • "instrument_pricing_scheme_filters": "string",
  • "instrument_pricing_condition_filters": "string",
  • "currency_pricing_scheme_filters": "string",
  • "currency_pricing_condition_filters": "string",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Run procedure

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

A unique integer value identifying this pricing procedure.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Request Data Procedure

List

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

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Execute

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Read

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

A unique integer value identifying this request data file procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Update

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Partial update

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Delete

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

A unique integer value identifying this request data file procedure.

Responses

Delete preview

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

A unique integer value identifying this request data file procedure.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}

Run procedure

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

A unique integer value identifying this request data file procedure.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Human Readable Name of the object

user_code
string or null (User code) <= 255 characters
notes
string or null (Notes)

Notes, any useful information about the object

provider
required
integer (Provider)
scheme_user_code
required
string (Scheme user code) [ 1 .. 1024 ] characters
scheme_type
string (Scheme type)
Enum: "transaction_import" "simple_import"
data
object or null (Data)
date_from_expr
string or null (Date from expr) <= 4096 characters
Default: ""
date_to_expr
string or null (Date to expr) <= 4096 characters
Default: ""
date_from
string or null <date> (Price date from)
date_to
string or null <date> (Price date to)
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
object (DataProvider)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "provider_object": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "notes": "string",
  • "provider": 0,
  • "scheme_user_code": "string",
  • "scheme_type": "transaction_import",
  • "data": { },
  • "date_from_expr": "",
  • "date_to_expr": "",
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "configuration_code": "string",
  • "deleted_user_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "provider_object": {
    }
}