Skip to main content
POST
Find P&L report-run summaries for a portfolio and date range.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The body containing the required accessible PortfolioName, optional PortfolioType for disambiguation, and inclusive InitialDateTime and FinalDateTime bounds. Portfolio identifiers, access type, allowed portfolio types, and caller context are server-managed. No additional time-zone conversion is defined.

Date-range selectors for listing P&L report-run summaries.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetPnlReportInfoRequest, Derivitec.Web.Core
portfolio_name
string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
final_date_time
string<date-time>

Upper date or date-time bound of the requested report period; inclusivity and time zone are not defined here.

initial_date_time
string<date-time>

Lower date or date-time bound of the requested report period; inclusivity and time zone are not defined here.

Response

Returns matching P&L report-run summaries, or an unsuccessful envelope when no summaries match.

Response envelope containing P&L report-run summaries.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetPnlReportInfoResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

report_infos
object[] | null

Report-run summaries matching the request selectors.