Schemas Postman

Counterparty. Fetch data by request POST

get data of System Settings by parametrs

# ENDPOINT
/api/clientCounterparty/getData/clientCounterpartySearchRequest
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: clientCounterpartySearchRequest
Type: object
Variable Name Type Format Usage Description
account_number account_number string Account_number
blacklist_code blacklist_code string
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string Client group
counterparty_code counterparty_code string Counterparty code
counterparty_id counterparty_id integer INT64 Counterparty id
date_of_birth date_of_birth string DATE Customer date of birthday
entity_type entity_type string Customer type
first_name first_name string First name of a given customer (user)
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
iban iban string A unique account IBAN generated by the System according to IBAN generation rules
last_name last_name string Last name of a given customer (user)
limit limit integer int64 Count records for part data to get
offset_version Offset version INTEGER
offsetid Offsetid integer
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
registration_number registration_number string Registration number of a legal entity or personal code of an individual (user)
relation_code relation_code string Relation code
search Search string
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: clientCounterparty
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data array data of Response
attribute: data
Variable Name Type Format Description
action Action string
applicant Applicant BOOLEAN
blacklist_code blacklist_code string
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
counterparty_account counterparty_account string Counterparty account
counterparty_code counterparty_code string Counterparty code
counterparty_entity_type counterparty_entity_type string Counterparty Type
counterparty_first_name counterparty_first_name string Counterparty first name
counterparty_full_name counterparty_full_name string Counterparty full name
counterparty_iban counterparty_iban string Counterparty IBAN
counterparty_id counterparty_id integer INT64 Counterparty id
counterparty_last_name counterparty_last_name string Counterparty lase name
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
ownership Ownership % NUMBER
positionsList Positionslist STRING
relation_code relation_code string Relation code
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
Counterparty. Fetch data by ID /model/clientCounterparty/getDb/{id}
Counterparty. Validate data /model/clientCounterparty/validate
Counterparty. Prepare data /model/clientCounterparty/prepare
Counterparty. Create/update data /model/clientCounterparty/putDb
Counterparty. Delete item by ID /api/clientCounterparty/deleteItem/{id}