ScheduleTreasuryActivityReport

Category: User Permissions: Operator, Trading Call Type: Synchronous

Schedules a series of treasury activity reports for a list of accounts on a single Order Management System, starting at a specific date/time, and covering a specific time interval. Treasury activities are non-trading transactions such as deposits and withdrawals. The reports runs periodically until canceled.

A user with Trading permission may schedule reports only for accounts with which he is associated; a user with Operator permission may schedule reports for any accounts.

The Treasury Activity Report itself is delivered as a comma-separated-value (CSV) file. For specific CSV formatting information, see the APEX Extract CSV Data Dictionary, available from AlphaPoint.

Request

{
  "frequency":0,
  "accountIdList":[1],
  "omsId":1,
  "beginTime":"2018-08-10T04:00:00.000Z",
  "intervalDuration":10
 }

Key	Value
frequency	integer. How often the report will run. A number represents one of: 0 OnDemand 1 Hourly 2 Daily 3 Weekly 4 Monthly 5 Annually
accountIdList	integer array. Comma-separated integers; each element is an account ID whose treasury activity will be reported on. All accounts must be from the same OMS.
omsId	integer. The Order Management System on which the accounts named in the list reside.
beginTime	string. The time from which the treasury activities will be reported, in Microsoft Ticks format.
intervalDuration	integer. The length of time prior to the run time that the report covers. For example, 90 days. Whenever the report runs, it looks back 90 days.

Key

Value

frequency

integer. How often the report will run. A number represents one of: 0 OnDemand 1 Hourly 2 Daily 3 Weekly 4 Monthly 5 Annually

accountIdList

integer array. Comma-separated integers; each element is an account ID whose treasury activity will be reported on. All accounts must be from the same OMS.

omsId

integer. The Order Management System on which the accounts named in the list reside.

beginTime

string. The time from which the treasury activities will be reported, in Microsoft Ticks format.

intervalDuration

integer. The length of time prior to the run time that the report covers. For example, 90 days. Whenever the report runs, it looks back 90 days.

Response

{
  "RequestingUser":1,
  "OMSId":1,
  "reportFlavor":"Treasury",
  "createTime":"2018-08-17T18:02:03Z",
  "initialRunTime":"2018-08-10T04:00:00Z",
  "intervalStartTime":"2018-08-10T04:00:00Z",
  "intervalEndTime":"2018-08-10T05:00:00Z",
  "RequestStatus":"Submitted",
  "ReportFrequency":"Hourly",
  "intervalDuration":36000000000,
  "RequestId":"xbsVgAuUcEyTFgf/gpWB2A==",
  "lastInstanceId":"AAAAAAAAAAAAAAAAAAAAAA==",
  "accountIds":[1]
}

Similar objects are returned for Generate~Report and Schedule~Report calls.

Key	Value
RequestingUser	integer. The User ID of the person requesting the treasury activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response.
OMSId	integer. The ID of the Order Management System on which the treasury activity report will be run.
reportFlavor	string. The type of report to be generated. One of: TradeActivity Transaction Treasury The reportFlavor string confirms the nature of the call.
createTime	string. The time and date on which the request for the treasury activity report was made, in Microsoft Ticks format.
initialRunTime	string. The time and date at which the treasury activity report was first run, in Microsoft Ticks format.
intervalStartTime	string. The start of the period that the report will cover, in Microsoft Ticks format.
intervalEndTime	string. The end of the period that the report will cover, in Microsoft Ticks format.
requestStatus	string. The status of the request for the treasury activity report. One of: Submitted Validating Scheduled InProgress Completed Aborting Aborted UserCancelled SysRetired UserCancelledPending
ReportFrequency	string. When the report runs. Note that frequency in the request is an integer; but ReportFrequency in the response is a string. OnDemand Hourly Daily Weekly Monthly Annually
intervalDuration	long integer. The period that the report covers relative to the run date, in POSIX format. For example, say that you schedule a weekly report with a 90-day intervalDuration value. intervalDuration represents the backward-looking period of the report. When the report runs again in a week’s time, it again looks back 90 days — but now those 90 days are offset by a week from the first report.
RequestId	string. The ID of the original request. Request IDs are long strings unique within the Order Management System.
lastInstanceId	string. For scheduled reports, the report ID of the most recent previously run report.
accountIds	integer array. A comma-delimited array of account IDs whose trades are reported in the trade activity report.

Key

Value

RequestingUser

integer. The User ID of the person requesting the treasury activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response.

OMSId

integer. The ID of the Order Management System on which the treasury activity report will be run.

reportFlavor

string. The type of report to be generated. One of: TradeActivity Transaction Treasury The reportFlavor string confirms the nature of the call.

createTime

string. The time and date on which the request for the treasury activity report was made, in Microsoft Ticks format.

initialRunTime

string. The time and date at which the treasury activity report was first run, in Microsoft Ticks format.

intervalStartTime

string. The start of the period that the report will cover, in Microsoft Ticks format.

intervalEndTime

string. The end of the period that the report will cover, in Microsoft Ticks format.

requestStatus

string. The status of the request for the treasury activity report. One of: Submitted Validating Scheduled InProgress Completed Aborting Aborted UserCancelled SysRetired UserCancelledPending

ReportFrequency

string. When the report runs. Note that frequency in the request is an integer; but ReportFrequency in the response is a string. OnDemand Hourly Daily Weekly Monthly Annually

intervalDuration

long integer. The period that the report covers relative to the run date, in POSIX format. For example, say that you schedule a weekly report with a 90-day intervalDuration value. intervalDuration represents the backward-looking period of the report. When the report runs again in a week’s time, it again looks back 90 days — but now those 90 days are offset by a week from the first report.

RequestId

string. The ID of the original request. Request IDs are long strings unique within the Order Management System.

lastInstanceId

string. For scheduled reports, the report ID of the most recent previously run report.

accountIds

integer array. A comma-delimited array of account IDs whose trades are reported in the trade activity report.

PreviousScheduleTransactionActivityReport NextTrades

Last updated 3 months ago