Skip to main content

RequestCreditOrdersSummary

Request a summary of the list of all credit orders

Request format

{
"RequestId": "0f4760f7-a57c-4dfb-8f1f-2b8ccca9d550",
"Search": "usa",
"AccountsGroups": [
"real",
"demo"
],
"Countries": [
"Russia",
"USA"
],
"PageSize": 100,
"PageNum": 1,
"Nodes": [
"node1",
"node2"
],
"RequestName": "RequestCreditOrdersSummary"
}

Request parameters:

NameDescription
RequestIdUnique request GUID
SearchOrder filter, works for the fields Order, Login, Group, Country, Currency, Symbol, Comment
AccountsGroupsList of account groups
CountriesList of countries
NodesList of nodes that participate in the request. If the list is empty, then all available nodes are called.
RequestNameRequest type

Response ResponseCreditOrdersSummary

 {
"Result": {
"Total": 159,
"TotalCreditInUsd": 206252.77,
"TotalOverdueCreditsInUsd": 1000,
"Accounts": 90
},
"Errors": [],
"RequestId": "21b648d2-1c44-4276-8a6a-91fe6e9f5080",
"ResponseMaster": "ResponseCreditOrdersSummary"
}

TotalCreditInUsd field contains credit in USD AT THE RATE AT THE TIME OF REQUEST

Errors is either an empty list or a list of responses of the ResponseNodeError nodes