API ReferenceTradingTrading Fa Model Portfolios

Model Cash Analyzer

View as MarkdownOpen in Claude
Run the model cash analyzer to review pending cash transfers, FX conversion orders, and any margin warnings that would result from the currently pending model allocation plan.

Authentication

AuthorizationBearer
SSO bearer token.

Request

This endpoint expects an object.
reqIDlongRequired
Request identifier to uniquely track a request.
subscriptionKeystringOptional
Subscription key. Send an empty string on the initial request.

Response

Successfully retrieved the cash analyzer summary.
cashTransferslist of objectsOptional
Cash transfers required by the current allocation plan.
errorstring or nullOptional

Error message produced by the analyzer, or null if none.

fxconvorderslist of objectsOptional
FX conversion orders required to fund the plan.
marginWarningbooleanOptional
True if the plan would trigger a margin warning.
reqIDlongOptional
Request identifier echoed from the originating request.
subscriptionStatuslongOptional
Describes if the model is in polling mode.
successbooleanOptional
Signifies that the analyzer completed successfully.
transfersInstructionIdlongOptional

Identifier that groups the resulting transfers; supply to downstream submit endpoints.

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error